Skip to content

Commit

Permalink
docs: document GitLab container registry usage (#19321)
Browse files Browse the repository at this point in the history
  • Loading branch information
JMLX42 committed Dec 9, 2022
1 parent 501eaad commit 654236d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions lib/modules/platform/gitlab/index.md
Expand Up @@ -9,13 +9,15 @@ For real runs, give the PAT these scopes:
- `read_user`
- `api`
- `write_repository`
- `read_registry` (only if Renovate needs to access the [GitLab Container registry](https://docs.gitlab.com/ee/user/packages/container_registry/))

For dry runs, give the PAT these scopes:

- `read_user`
- `read_api`
- `read_repository`
- `write_repository` (when using autodiscover)
- `read_registry` (only if Renovate needs to access the [GitLab Container registry](https://docs.gitlab.com/ee/user/packages/container_registry/))

Let Renovate use your PAT by doing _one_ of the following:

Expand All @@ -25,6 +27,12 @@ Let Renovate use your PAT by doing _one_ of the following:

Remember to set `platform=gitlab` somewhere in your Renovate config file.

If you're using a private [GitLab container registry](https://docs.gitlab.com/ee/user/packages/container_registry/), you must:

- Set the `RENOVATE_HOST_RULES` CI variable to `[{"matchHost": "${CI_REGISTRY}","username": "${GITLAB_USER_NAME}","password": "${RENOVATE_TOKEN}"}]`.
- Make sure the user that owns the `RENOVATE_TOKEN` PAT is a member of the corresponding GitLab projects/groups with the right permissions.
- Make sure the `RENOVATE_TOKEN` PAT has the `read_registry` scope.

## Features awaiting implementation

- The `automergeStrategy` configuration option has not been implemented for this platform, and all values behave as if the value `auto` was used. Renovate will accept the Merge Request without further configuration, and respect the strategy defined in the Merge Request, and this cannot be overridden yet
Expand Down

0 comments on commit 654236d

Please sign in to comment.