- Notifications
You must be signed in to change notification settings - Fork45
Simplify and clarify GitHub integration instructions#442
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
jmacdotorg wants to merge6 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Open
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
0c790c4 Update the GIt platform integration overview page. Update and simplif…
jmacdotorg68f441a Update the sidebar label of the overview page to "Overview"
jmacdotorg7bc3ff4 Spacing tweak
jmacdotorg91f833f More spacing tweaks.
jmacdotorgfa2fded Making requested changes
jmacdotorg871babc Merge branch 'main' into github
jmacdotorgFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
124 changes: 59 additions & 65 deletionsdocs/platforms/github-com.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,116 +1,110 @@ | ||
| --- | ||
| title:Integrate with GitHub.com | ||
| description: Learn how to integrate CodeRabbit and add to your GitHub workflow. | ||
| sidebar_label: GitHub.com | ||
| --- | ||
| This is a step-by-step guide to integrate CodeRabbit with your GitHub repositories. | ||
| For an overview of how CodeRabbit integrates with Git platforms, see | ||
| [Add CodeRabbit to your repository](/platforms). | ||
| For a hands-on tutorial with CodeRabbit performing code reviews on a live | ||
| GitHub repository that you create, see [Quickstart](/getting-started/quickstart). | ||
| ## Before you begin | ||
| You need to have a GitHub account,andownership-level permissions of at least one repository associated with that account. | ||
| If you want to authorizeCodeRabbitto write code reviews for a repository contained in a GitHub organization, then you need ownership-level permission with that organization, as well. | ||
| ##AuthorizeCodeRabbit withyourGitHub account | ||
| Before you can you use CodeRabbit with GitHub, you need to | ||
| authorize CodeRabbit with your GitHub account. To do this, follow these steps: | ||
| 1.Visit[the CodeRabbit login page](https://app.coderabbit.ai/login). | ||
| 1. Click **Login with GitHub**. Your browser navigates to GitHub.com. | ||
| 1. If GitHub prompts to sign in to your GitHub account before continuing, then enter your GitHub login credentials as you normally would. Otherwise, continue to the next step. | ||
| 1. GitHub displays a summary of the information that CodeRabbit needs in order to integrate with your | ||
| GitHub account. This includes read-only access to the following: | ||
| - Organizations and teams that are associated with your GitHub account. | ||
| - Email addresses that are associated with your GitHub account. | ||
| To allow CodeRabbit access to this information, click **Authorize coderabbitai**. | ||
| After you complete these steps, your browser navigates to the CodeRabbit web interface. | ||
| Now thatyou've integrated CodeRabbit with your GitHub account, you needtogive CodeRabbit additional permissionstowork withyour code repositories. To do this, see thenext section. | ||
| ## Allow CodeRabbit to access your repositories | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I know you added trust center link, but it is better to add a note aka admonishment to highlight the trust center and informing the user we don't store your code by default. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. OK, I wrapped this text in a note. | ||
| Even after you've integrated CodeRabbit with your GitHub account, you need to | ||
| separately grant CodeRabbit the permissions that it needs to post code reviews and | ||
| create pull requests in your repositories. | ||
| You need to authorize CodeRabbit separately for each GitHub organization whose repositories you want it to work with. You can give CodeRabbit permission to | ||
| work with all of the repositories associated with a GitHub organization, or limit its access to a select list. | ||
| ### Overview of required permissions | ||
| CodeRabbitrequires the following permissions to work with your repositories: | ||
| - Read-only access to actions, checks, discussions, members, and metadata. | ||
| - Read-and-write access to code, commit statuses, issues, and pull requests. | ||
| :::note | ||
| CodeRabbit requests read and write access to your repository in order for its code review, issue management, and pull request generation features to work. CodeRabbit never stores your code. For more information, see [the CodeRabbit Trust Center](https://trust.coderabbit.ai). | ||
| ::: | ||
| ### Grant required permissions | ||
| To giveCodeRabbit access to one or more of your repositories, follow these steps: | ||
| 1. Visit [the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories). | ||
| 1. Make sure that the correct GitHub organization for the repository is displayed | ||
| at the top of the web interface. To change the organization, click **Change | ||
| Organization** and select a different organization from the list. | ||
| If the repositories that you want to add are associated directly with your GitHub account, and not a separate organization, then select your account name as the organization. | ||
| If the organization containing the repository doesn't appear in the list, then you might | ||
| need to refresh the list of organizations that CodeRabbit has associated with your | ||
| GitHub account. For more information, see [Add organizations](/getting-started/adding-organizations). | ||
| 1. Clickthe**Add Repositories** button. Your browser navigates to GitHub.com. | ||
| If the selected organization has no repositories registered withCodeRabbit, then your browser displays a CodeRabbit permissions dialog for setting up a new integration. Proceed to the next step. | ||
| Otherwise, your browser displays a GitHub settings pageforyour organization's existing CodeRabbit integration. Scroll down tothesection titled **Repository access**, and then proceed to the next step. | ||
| 1. Select which repositories you'd like to allowCodeRabbit to write code reviews for. | ||
| To give CodeRabbit accesstoall repositories in the organization, select **All repositories**. This alsoautomatically grants CodeRabbit access to all repositories added to the organization in the future. | ||
| To giveCodeRabbitaccess to specific, limited list of repositories, select **Only select repositories**, and then choose repositories fromthelist. | ||
| :::note | ||
| You can change this setting later. | ||
| ::: | ||
| 1. Click the button at the bottom of the form, which has one of the following labels, depending upon context: | ||
| - **Install & Authorize**, if this organization has no repositories integrated with CodeRabbit, and you are an owner of this organization. | ||
| - **Save**, if this organization already has repositories integrated with CodeRabbit | ||
| 1. If you are integrating an organization withCodeRabbit for the first time, then your browser navigates back to the CodeRabbit web interface. | ||
| Otherwise, your browser remains on your GitHub settings page, and you can manually navigate [back to the CodeRabbit web interface](https://app.coderabbit.ai/settings/repositories). | ||
| ## What'snext | ||
| - [Setyourrepository preferences](/guides/repository-settings) | ||
| - [Review pull requests](/guides/code-review-overview) | ||
55 changes: 32 additions & 23 deletionsdocs/platforms/platforms.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,44 @@ | ||
| --- | ||
| title: Add CodeRabbit to your repository | ||
| description: Conceptual overview of integrating CodeRabbit with your Git platform | ||
| sidebar_label: Overview | ||
| --- | ||
| This page presents an overview of integrating CodeRabbit with your Git platform. | ||
| For a conceptual overview of CodeRabbit, see [Introduction](/). | ||
| ##Use CodeRabbit with Git platforms | ||
| CodeRabbit integrates with the following Git platforms: | ||
| - [GitHub.com](/platforms/github-com) | ||
| - [GitHub Enterprise Server](/platforms/github-enterprise-server) | ||
| - [GitLab.com](/platforms/gitlab-com) | ||
| - [Self-managed GitLab](/platforms/self-hosted-gitlab) | ||
| - [Azure DevOps](/platforms/azure-devops) | ||
| - [BitBucket Cloud](/platforms/bitbucket-cloud) | ||
| The exact steps for each platform are outlined in the pages linked above. That said, integrating any | ||
| Git platform with CodeRabbit follows this general pattern: | ||
| 1. Log into CodeRabbit using your Git platform account. | ||
| 1. Add the organizations containing the repositories that you want CodeRabbit to work with. You generally need ownership-level permissions with these organizations. (Different Git platforms might call their organizations different | ||
| things, such as "groups" in GitLab and "workspaces" in BitBucket.) | ||
| 1. Create a dedicated CodeRabbit service account on your Git platform, if needed. We handle | ||
| this step for you on some platforms, such as GitHub.com. | ||
| 1. Grant CodeRabbit the permissions that it needs to work with one or more | ||
| of the repositories that you have ownership-level access to. | ||
| After you finish integrating CodeRabbit with one or more repositories, you can [start using CodeRabbit immediately](/guides/code-review-overview) using its default configuration, which automatically reviews or summarizes new pull requests. You can also [customize CodeRabbit’s configuration](/guides/configuration-overview) to suit your team's needs. | ||
| ## What's next {#whats-next} | ||
| - [Integrate CodeRabbit with GitHub.com](/platforms/github-com) | ||
| - [Integrate CodeRabbit with GitHub Enterprise Server](/platforms/github-enterprise-server) | ||
| - [Integrate CodeRabbit with GitLab.com](/platforms/gitlab-com) | ||
| - [Integrate CodeRabbit with Self-managed GitLab](/platforms/self-hosted-gitlab) | ||
| - [Integrate CodeRabbit with Azure DevOps](/platforms/azure-devops) | ||
| - [Integrate CodeRabbit with BitBucket Cloud](/platforms/bitbucket-cloud) |
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.