From 8fb75c16af3f88065aab2a58fba16a4c35e021b3 Mon Sep 17 00:00:00 2001 From: Ori Kotek Date: Mon, 11 Mar 2024 20:08:16 +0200 Subject: [PATCH] doc update --- docs/docs/installation/gitlab_pro.md | 37 ++++++++++++++++++++++++++++ docs/mkdocs.yml | 1 + 2 files changed, 38 insertions(+) create mode 100644 docs/docs/installation/gitlab_pro.md diff --git a/docs/docs/installation/gitlab_pro.md b/docs/docs/installation/gitlab_pro.md new file mode 100644 index 00000000..20902b74 --- /dev/null +++ b/docs/docs/installation/gitlab_pro.md @@ -0,0 +1,37 @@ +## Install Hosted PR-Agent Pro for GitLab (Teams & Enterprise) + +### Step 1 + +Acquire a personal, project or group level access token. Enable the “api” scope in order to allow PR-Agent to read pull requests, comment and respond to requests. + + + +Store the token in a safe place, you won’t be able to access it again after it was generated. + +### Step 2 + +Generate a shared secret and link it to the access token. Browse to [https://register.gitlab.pr-agent.codium.ai](https://register.gitlab.pr-agent.codium.ai). +Fill in your generated GitLab token and your company or personal name in the appropriate fields and click "Submit". + +You should see "Success!" displayed above the Submit button, and a shared secret will be generated. Store it in a safe place, you won’t be able to access it again after it was generated. + +### Step 3 + +Install a webhook for your repository or groups, by clicking “webhooks” on the settings menu. Click the “Add new webhook” button. + + + +In the webhook definition form, fill in the following fields: +URL: https://pro.gitlab.pr-agent.codium.ai/webhook + +Secret token: Your CodiumAI key +Trigger: Check the ‘comments’ and ‘merge request events’ boxes. +Enable SSL verification: Check the box. + + + +### Step 4 + +You’re all set! + +Open a new merge request or add a MR comment with one of PR-Agent’s commands such as /review, /describe or /improve. \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b71bf125..6e8153cf 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -7,6 +7,7 @@ nav: - Locally: 'installation/locally.md' - GitHub: 'installation/github.md' - GitLab: 'installation/gitlab.md' + - 💎 GitLab Pro: 'installation/gitlab_pro.md' - BitBucket: 'installation/bitbucket.md' - Azure DevOps: 'installation/azure.md' - Usage Guide: