Skip to content

Commit

Permalink
docs: document GitLab version for automatic webhook creation (#612)
Browse files Browse the repository at this point in the history
* Updated docs for GitLab setup to indicate supported GitLab version for automatic webhook creation.

* Updated GitLab minimum version to 17.1.
Also fixed typo.
  • Loading branch information
justo-mend authored Nov 25, 2024
1 parent f53493d commit 22e02cc
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/setup-for-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ When enabled, will automatically install webhooks for all repos that are enabled

Webhook installation requires an admin user account that has `Maintainer` access to the repos.

> [!WARNING]
>
> Automatic webhook creation works for GitLab v17.1 and higher.
> Using the automatic webhook creation on versions lower than v17.1 can cause unexpected results, including the creation of multiple identical webhooks.
> [!NOTE]
>
> This admin account used for webhooks can be the repo owner account, or it can be another account that has more limited access to the repos.
Expand All @@ -73,8 +78,9 @@ Webhook installation requires an admin user account that has `Maintainer` access
To enable automatic webhook creation:

Set `MEND_RNV_WEBHOOK_URL`:
- DO NOT use this feature on GitLab versions lower than v17.1!
- When set, webhooks will be installed on repos when Renovate is enabled.
- Set the webhook URL to point to the Renovate server url followed by `/webhook`. (e.g. `http://renovate.yourcompany.com:8080/webhook` or `https://1.2.3.4/webhook`)
- Set the webhook URL to point to the Renovate server url followed by `/webhook`. (e.g. `http://renovate.yourcompany.com:8080/webhook` or `https://1.2.3.4/webhook`)

Set `MEND_RNV_ADMIN_TOKEN`: [Optional]
- Could be repo owner account, or special high-privilege account.
Expand Down Expand Up @@ -122,7 +128,7 @@ You can add **Repo webhooks** to each individual repo that you want webhooks ena

##### SSL Verification

- Diasble SSL verification unless required by your server
- Disable SSL verification unless required by your server

## Run Mend Renovate Self-hosted App

Expand Down

0 comments on commit 22e02cc

Please sign in to comment.