diff --git a/lib/modules/platform/gitea/index.md b/lib/modules/platform/gitea/index.md index 098fb39be1f9fcf9efd49aa62795c06e8bb59075..a6c51d7f8ff79790ffc0ac1a0051120ffe96b050 100644 --- a/lib/modules/platform/gitea/index.md +++ b/lib/modules/platform/gitea/index.md @@ -1,25 +1,32 @@ # Gitea and Forgejo -Renovate supports [Gitea](https://gitea.io) and the new fork [Forgejo](https://forgejo.org). +Renovate supports [Gitea](https://gitea.io) and the [Forgejo](https://forgejo.org) fork. Forgejo exists since `v1.18.0` and is currently fully compatible to Gitea. ## Authentication -First, [create a Personal Access Token](https://docs.gitea.io/en-us/api-usage/#authentication) for the bot account. -Let Renovate use your PAT by doing _one_ of the following: +First, [create a Personal Access Token (PAT)](https://docs.gitea.io/en-us/api-usage/#authentication) for the bot account. +The bot account should have full name and email address configured. +Then let Renovate use your PAT by doing _one_ of the following: - Set your PAT as a `token` in your `config.js` file - Set your PAT as an environment variable `RENOVATE_TOKEN` - Set your PAT when you run Renovate in the CLI with `--token=` -Remember to set `platform=gitea` somewhere in your Renovate config file. -Either the account should have full name and email address set to allow Renovate to estabilish Git identity, or the `gitAuthor` config option should be set. +You must set `platform=gitea` in your Renovate config file. + +The PAT should have these permissions: + +- `repo` +- `read:user` and `read:email` + +If you use Gitea packages, add the `read:packages` scope. ## Unsupported platform features/concepts -- **Adding reviewers to PRs not supported**: Gitea versions older than `v1.14.0` do not have the required API. -- **Setting `platformAutomerge` to use platform-native automerge for PRs not supported**: Gitea versions older than v1.17.0 do not have the required API. -- **Git upload filters**: If you're using a Gitea version older than `v1.16.0` then you must enable [clone filters](https://docs.gitea.io/en-us/clone-filters/). +- **Adding reviewers to PRs not supported**: Gitea versions older than `v1.14.0` lack the required API +- **Setting `platformAutomerge` to use platform-native automerge for PRs not supported**: Gitea versions older than `v1.17.0` lack the required API +- **Git upload filters**: If you're using a Gitea version older than `v1.16.0` then you must enable [clone filters](https://docs.gitea.io/en-us/clone-filters/) ## Features awaiting implementation