Commit02350b2

authored

Refactor GitLab webhook script section for clarity and formatting (coderabbitai#447)

* Refactor GitLab webhook script section for clarity and formatting* Clarify comments in gitlab-webhook.sh regarding PAT usage examples* Clarify description of the webhook script usage in GitLab documentation* Fix formatting for selecting triggers in GitLab webhook documentation

1 parent07ae251 commit02350b2Copy full SHA for 02350b2

File tree

2 files changed

+10

-4

lines changed

docs/self-hosted
- gitlab.md
static/code
- gitlab-webhook.sh

2 files changed

+10

-4

lines changed

`‎docs/self-hosted/gitlab.md‎`

Lines changed: 8 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -37,19 +37,25 @@ Consult official CodeRabbitAI documentation for a detailed [guide](https://docs.`
`37`	`37`	`1.Navigate to Add Webhook Page: Go to the webhook configuration page in the desired GitLab project.`
`38`	`38`	2.Add Webhook URL: Enter the URL pointing to the CodeRabbit service, followed by`/gitlab_webhooks` (e.g.,`http://127.0.0.1:8080/gitlab_webhooks`).
`39`	`39`	3.Generate and Save Secret Token: Generate a secret token, add it to the webhook, and store it securely. This will be needed for the`.env` file as`GITLAB_WEBHOOK_SECRET` (you can use a single secret token for all projects).
`40`		`-4. Select triggers:`
	`40`	`+4.Select triggers:`
`41`	`41`
`42`	`42`	`- Push events`
`43`	`43`	`- Comments`
`44`	`44`	`- Issues events`
`45`	`45`	`- Merge request events`
`46`	`46`
`47`		`-We have a convenient[script](/code/gitlab-webhook.sh) to help you add webhooks to all projects in a GitLab instance. You can run it with the following command:`
	`47`	`+##Add Webhook Using a Script`
	`48`	`+`
	`49`	`+We have a convenient[script](/code/gitlab-webhook.sh) to help you add webhooks to a project or all projects under a group in a GitLab instance.`
`48`	`50`
`49`	`51`	```bash
`50`	`52`	`# Make sure the script is executable:`
`51`	`53`	`chmod +x gitlab-webhook.sh`
	`54`	+```
`52`	`55`
	`56`	`+Example usage:`
	`57`	`+`
	`58`	+```bash
`53`	`59`	`# PAT example (header auto-detected)`
`54`	`60`	`export GITLAB_TOKEN="glpat-xxxxx"`
`55`	`61`	`./gitlab-add-webhook.sh \`

`‎static/code/gitlab-webhook.sh‎`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,13 @@`
`7`	`7`	`# Make sure the script is executable:`
`8`	`8`	`# chmod +x gitlab-webhook.sh`
`9`	`9`
`10`		`-# PATexample (headerauto-detected)`
	`10`	`+# PAT auto-detected header`
`11`	`11`	`# export GITLAB_TOKEN="glpat-xxxxx"`
`12`	`12`	`# ./gitlab-add-webhook.sh \`
`13`	`13`	`# -h "gitlab.example.com" -u "https://ci.example.com/gitlab-hook" \`
`14`	`14`	`# -s "mySecret" -p 42`
`15`	`15`
`16`		`-# PATexample (explicit header)`
	`16`	`+# PATwithexplicit header`
`17`	`17`	`# ./gitlab-add-webhook.sh \`
`18`	`18`	`# -h "gitlab.example.com" -u "https://ci.example.com/gitlab-hook" \`
`19`	`19`	`# -s "mySecret" -g "mygroup/mysubgroup/myproject" \`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit02350b2

File tree

2 files changed

2 files changed

`‎docs/self-hosted/gitlab.md‎`

`‎static/code/gitlab-webhook.sh‎`

0 commit comments