|
| 1 | +--- |
| 2 | +title:Integrating CodeRabbit with SaaS Azure DevOps |
| 3 | +description:Integrate CodeRabbit with SaaS Azure DevOps. |
| 4 | +sidebar_label:SaaS Azure DevOps BETA |
| 5 | +sidebar_position:4 |
| 6 | +--- |
| 7 | + |
| 8 | +This guide will assist you in effectively integrating CodeRabbit with SaaS Azure DevOps. |
| 9 | + |
| 10 | +##Prerequisites |
| 11 | + |
| 12 | +* An active Azure DevOps account. |
| 13 | +* Use of organizational email addresses is required; personal email addresses are not supported for this integration. |
| 14 | + |
| 15 | +##Integration Instructions |
| 16 | +1. Log in to the CodeRabbitAI application. |
| 17 | +2. After logging in, you will be redirected to a page displaying Microsoft Apps consent requests. Please forward these requests to your administrator for approval. |
| 18 | + |
| 19 | +:::warning |
| 20 | + |
| 21 | +If you are an administrator, you may approve the applications directly. If not, please contact your administrator to request approval for the applications. |
| 22 | + |
| 23 | +::: |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +3. Once your administrator has approved the applications, click "Continue." |
| 28 | +4. You will be redirected to the "Onboarding" page, where you can select the organization you wish to integrate with. |
| 29 | +5. On the "Azure DevOps User" page, enter your Personal Access Token for Azure DevOps. |
| 30 | + |
| 31 | +6. To install CodeRabbit on a repository, toggle the switch on the "Repositories" page. |
| 32 | + |
| 33 | +##How it works |
| 34 | + |
| 35 | +For the CodeRabbit app to post reviews on merge requests, it needs to interact with the Azure DevOps API, which requires a Personal Access Token. This token can be generated by creating a Personal Access Token from one of your existing users. |
| 36 | + |
| 37 | +You can create a new user in Azure DevOps and generate a Personal Access Token for that user, following[our recommendations](#recommendations). |
| 38 | + |
| 39 | +##Azure DevOps Personal Access Tokens |
| 40 | + |
| 41 | +To interact with the Azure DevOps API, a**Personal Access Token** is required. This token can be generated by creating a**Personal Access Token** from one of your existing users. |
| 42 | + |
| 43 | +Upon first login to the application (immediately after the onboarding screen), you will need to add the Personal Access Token. |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +###Recommendations |
| 48 | + |
| 49 | +***Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control. |
| 50 | +***Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference. |
| 51 | +***Use a dedicated email address** - This helps in easy identification and management. |
| 52 | +***Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from[here](/img/integrations/logo.svg"download"). |
| 53 | + |
| 54 | +###Key Points to Remember |
| 55 | + |
| 56 | +* Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app. |
| 57 | +* Code reviews will be attributed to the owner of the personal access token. |
| 58 | +* If the personal access token expires, you can add a new one via the CodeRabbit UI: |
| 59 | +* Navigate to the "AzureDevOps User" page in the sidebar. |
| 60 | +* Add the new token and click save. |
| 61 | + |
| 62 | +###Generating a Personal Access Token |
| 63 | + |
| 64 | +Azure DevOps provides an option to generate a personal access token for a user. Follow these steps to generate the token: |
| 65 | + |
| 66 | +1. Log in as the user intended for CodeRabbit reviews. |
| 67 | +2. Next to your avatar on the headers right side is a settings icon, click it. |
| 68 | +3. Choose "Personal Access Tokens" |
| 69 | +4. Click "New Token" |
| 70 | +5. Select the organization you want to use the token with or select "All accessible organizations." |
| 71 | +6. Enter a name and an expiry date for the token. |
| 72 | +7. We need to have read & write access to "Work Items" & "Code" to post reviews on pull requests. |
| 73 | +8. Click "Create" |
| 74 | + |
| 75 | + |