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