Skip to content

Update the GitLab docs with new PAT token changes #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 15, 2025
Merged

Update the GitLab docs with new PAT token changes #196

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
46374f7
Update the GitLab docs with new PAT token changes
karan925 Jan 14, 2025
4025213
address coderabbit comments
karan925 Jan 15, 2025
0149932
Merge branch 'main' into refactor/gitlab-docs-with-PAT-change
karan925 Jan 15, 2025
edca6f0
minor fix
karan925 Jan 15, 2025
cd7e5e1
minor fix
karan925 Jan 15, 2025
352d53a
🎨 pnpm run lint:fix
github-actions[bot] Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
address coderabbit comments
  • Loading branch information
@karan925
karan925 committed Jan 15, 2025
commit 40252130abafef66d369f6f85c9d3e84ec0c961b
8 changes: 4 additions & 4 deletions docs/platforms/gitlab-com.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ This guide will assist you in effectively integrating CodeRabbit with SaaS GitLa

To enable CodeRabbit to interact with your GitLab repositories, an access token is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs.

1. Personal Access Token (PAT): You can generate a PAT using a service account. We recommend creating a dedicated service account, associating it with the appropriate base group, and generating the PAT from this account.
1. Personal Access Token (PAT): You can create a new GitLab account specifically for CodeRabbit, name it “CodeRabbit” and treat it as a service account. Then generate a PAT from it where PAT will enable seamless integration between CodeRabbit and your GitLab repositories.
2. Group Access Token: If your organization uses GitLab Premium or Ultimate, you can generate a Group Access Token. This option automatically creates a bot user associated with the group for managing access and posting reviews.

### Personal Access Token

We recommend creating a new user as a service account, associating this user to the group you'd like to install coderabbit on, and provide CodeRabbit with a the personal access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.
We recommend creating a new user as a service account, associating this user to the group you'd like to install CodeRabbit on, and providing CodeRabbit with the personal access token to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.

<div class="center-image">
<img
Expand Down Expand Up @@ -67,7 +67,7 @@ choice"

GitLab provides an option to generate a personal access token for a new user. Follow these steps to generate the token:

1. Log in as the user intended for CodeRabbit reviews. You can treat this user as an service account.
1. Log in using the user designated for CodeRabbit reviews. This user serves as a service account for managing reviews and related activities.
2. Select your avatar on the left sidebar.
3. Choose **Edit Profile**.
4. Select **Access Tokens** from the left sidebar.
Expand All @@ -90,7 +90,7 @@ GitLab provides an option to generate a personal access token for a new user. Fo

### Group Access Token

Group Access token automatically create a bot user upon creation. With this, you simply just need to provide us the token and we will take care of the rest. Do keep in mind, a group access token only has a scope of the group it is created for. Additional groups that you wish to install CodeRabbit on will require a new group access token.
Creating a Group Access token automatically creates a bot user. With this, you simply just need to provide the token, and we will take care of the rest. Do keep in mind, a group access token only has a scope of the group it is created for. Additional groups that you wish to install CodeRabbit on will require a new group access token.

:::note

Expand Down