You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/saas-gitlab.md
+5-1
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ sidebar_label: SaaS GitLab
7
7
This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.
8
8
9
9
## How it works
10
+
10
11
For the CodeRabbit app to post reviews on merge requests, it needs to interact with the GitLab API, which requires a Personal Access Token. This token can be generated either by using our default CodeRabbit user or by creating a Personal Access Token from one of your existing users.
11
12
12
13
The CodeRabbit default user is already set up in GitLab SaaS and will be added to your project when you install the CodeRabbit app. During installation, the necessary webhook for the project will also be created.
@@ -21,6 +22,7 @@ Afterward, you will need to reinstall the CodeRabbit app for each project.
21
22
:::
22
23
23
24
## GitLab Access Tokens
25
+
24
26
To interact with the GitLab API, a **Personal Access Token** is required. This token can either be generated by using our default CodeRabbit user or by creating a **Personal Access Token** from one of your existing users.
25
27
26
28
Upon first login to the application (immediately after the onboarding screen), you will need to choose based on your organization's requirements.
@@ -30,11 +32,13 @@ Upon first login to the application (immediately after the onboarding screen), y
30
32
**We recommend using the default CodeRabbit user** for most organizations as it is pre-configured. However, we understand that some organizations may prefer more control over the user or have restrictions regarding user inclusion within their organization.
31
33
32
34
### Personal Access Tokens
35
+
33
36
If your organization opts to use another user within the organization, you can do so by [generating a personal access token](#generating-a-personal-access-token).
34
37
35
38
36
39
37
40
#### Recommendations
41
+
38
42
***Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
39
43
***Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
40
44
***Use a dedicated email address** - This helps in easy identification and management.
@@ -45,7 +49,7 @@ If your organization opts to use another user within the organization, you can d
45
49
* Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app.
46
50
* Code reviews will be attributed to the owner of the personal access token.
47
51
* If the personal access token expires, you can add a new one via the CodeRabbit UI:
48
-
* Navigate to the "GitLab User" page in the sidebar.
52
+
* Navigate to the "GitLab User" page in the sidebar.
49
53
* Click the "Update" button on the displayed card to see the same modal as the initial login.
Copy file name to clipboardExpand all lines: docs/integrations/self-hosted-gitlab.md
+5-1
Original file line number
Diff line number
Diff line change
@@ -31,14 +31,15 @@ If the self-managed GitLab instance is not found, we initiate the onboarding pro
31
31
### **Step 3: Onboarding Manual or Automated**
32
32
33
33
#### 1. Automated onboarding
34
+
34
35
35
36
36
37
#### **Why do we need the Admin Access Token?**
37
38
38
39
Admin access token is required to set up a new CodeRabbit bot user within your
39
40
self-managed instance. The token is needed only once during the initial setup
40
41
process. Once the token is generated, you can set its minimum expiration period.
41
-
This is the standard approach used by other products in this category.
42
+
This is the standard approach used by other products in this category.
42
43
This is not automatically installing the CodeRabbit
43
44
app across all projects. You will add CodeRabbit manually on the projects you
44
45
wish, as the next step.
@@ -49,6 +50,7 @@ For the manual onboarding process we need to create the [CodeRabbit user](#creat
49
50
50
51
51
52
#### **Creating CodeRabbit user**
53
+
52
54
This feature will work with any user from your organization, but we strongly suggest creating a
53
55
dedicated user called **CodeRabbitAI**. This ensures clarify about which user is used for our
54
56
application and allows for better fine-grained access control.
@@ -58,11 +60,13 @@ After the user is created, you can retrieve the **User ID** from that user's pro
58
60
The access token is used to post reviews on merge requests.
59
61
60
62
#### **Creating OAuth2 application**
63
+
61
64
For self-managed GitLab, we recommend creating an instance-wide application unless you want the reviews to be limited to a single group or user.
62
65
63
66
Please follow the steps outlined in the [GitLab documentation](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-an-instance-wide-application) for creating the application.
0 commit comments