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
When you connect your Azure DevOps Server project to your GitHub repositories, you support linking between GitHub commits and pull requests to work items. You can use GitHub for software development while using Azure Boards to plan and track your work.
21
20
22
21
> [!NOTE]
23
-
> On-premises Azure DevOps Server 2020 supports integration with GitHub.com and GitHub Enterprise Server repositories. If you want to connect from Azure DevOps Services, see [Connect Azure Boards to GitHub](./connect-to-github.md?preserve-view=true&view=azure-devops).
24
-
25
-
::: moniker-end
22
+
> Azure DevOps Server supports integration with GitHub.com and GitHub Enterprise Server repositories. To connect from Azure DevOps Services, see [Connect Azure Boards to GitHub](./connect-to-github.md?preserve-view=true&view=azure-devops).
26
23
27
24
## Prerequisites
28
25
@@ -34,77 +31,70 @@ When you connect your Azure DevOps Server project to your GitHub repositories, y
34
31
35
32
## Authentication options
36
33
37
-
The following authentication options are supported.
34
+
The following authentication options are supported:
> OAuth isn't supported for Azure DevOps Server 2020.
45
-
::: moniker-end
46
41
47
42
<aid="github-oauth"></a>
48
43
<aid="github-pat"></a>
49
44
<aid="server-github-ent-oauth-register"></a>
50
45
51
46
## Connect Azure DevOps Server to GitHub Enterprise Server
52
47
53
-
::: moniker range="azure-devops-2020"
54
48
You can connect up to 250 GitHub repositories to an Azure Boards project.
55
49
50
+
::: moniker range="azure-devops-2020"
56
51
> [!NOTE]
57
-
> Connection to more than 100 GitHub repositories requires Azure DevOps Server 2020.1 update or later version.
58
-
> Connection to GitHub.com repositories requires Azure DevOps Server 2020.1.1 Patch 2 or later version.
52
+
> -Connection to more than 100 GitHub repositories requires Azure DevOps Server 2020.1 update or later version.
53
+
> -Connection to GitHub.com repositories requires Azure DevOps Server 2020.1.1 Patch 2 or later version.
59
54
::: moniker-end
60
55
61
-
62
-
63
56
1. Open the web portal for your Azure DevOps Server.
64
57
65
58
2. Select the :::image type="icon" source="../../media/icons/project-icon.png" border="false"::: Azure DevOps logo to open **Projects**, and then choose the Azure Boards project you want to configure to connect to your GitHub Enterprise repositories.
:::image type="content" source="media/github-ent/open-project-settings-github-connections-2020-1.png" alt-text="Screenshot of open Project Settings>GitHub connections.":::
62
+
:::image type="content" source="media/github-ent/open-project-settings-github-connections-2020-1.png" alt-text="Screenshot of open Project Settings, GitHub connections.":::
72
63
73
-
4. If it's the first time making a connection from the project, choose the authentication method you want to use to make the connection:
64
+
4. If it's your first time making a connection from the project, choose the authentication method you want to use to make the connection:
74
65
75
-
- **Personal Access Token**, for details see [Connect using a Personal Access Token](#github-ent-pat).
76
-
- **GitHub credentials**, see [Connect using GitHub credentials](#server-github-ent-credentials).
66
+
- **GitHub Personal Access Token**: For details, see [Connect using a GitHub PAT](#github-ent-pat).
67
+
- **GitHub credentials**: For details, see [Connect using GitHub credentials](#server-github-ent-credentials).
77
68
78
69
:::image type="content" source="media/github-ent/connect-github-account-first-time.png" alt-text="Screenshot of first time connecting with GitHub credentials.":::
79
70
80
71
Otherwise, select :::image type="icon" source="../../media/icons/add-light-icon.png" border="false"::: **New connection**, and the select your authentication method from the **New Connection** dialog.
81
-
::: moniker-end
82
72
83
73
<aid="server-github-ent-pat"></a>
84
74
<aid="github-ent-pat"></a>
85
75
86
-
####Connect with a Personal Access Token
76
+
## Connect Azure DevOps Server with a GitHub Personal Access Token
87
77
88
-
1. To create a PAT, see [Creating a personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
78
+
1. To create a GitHub PAT, see [Create a GitHub PAT](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
89
79
90
80
> [!TIP]
91
81
> When you create your GitHub PAT, make sure that you include these scopes: `repo, admin:repo_hook, read:user, user:email`.
92
82
93
83
1. Enter the URL for your GitHub Enterprise server and the **Personal access token** credentials recognized by that server. And then select **Connect**.
94
84
95
-
:::image type="content" source="media/github-ent/ads-add-ghe-pat.png" alt-text="Screenshot of sign in with PAT.":::
85
+
:::image type="content" source="media/github-ent/ads-add-ghe-pat.png" alt-text="Screenshot of sign in with GitHub PAT.":::
96
86
97
87
<aid="server-github-ent-credentials"></a>
98
88
99
-
####Connect with GitHub credentials
89
+
## Connect Azure DevOps Server with GitHub credentials
100
90
101
91
1. Enter the URL for your GitHub Enterprise server and the administrator account credentials recognized by that server. And then choose **Connect**.
102
92
103
-
:::image type="content" source="media/github-ent/ads-add-ghe-user-name.png" alt-text="Screenshot of sign in with GitHub credentials.":::
93
+
:::image type="content" source="media/github-ent/ads-add-ghe-user-name.png" alt-text="Screenshot of sign in with GitHub credentials.":::
104
94
105
95
2. The dialog lists all repositories for which you have GitHub administration rights. You can toggle between **Mine** and **All** to determine if others appear, and then check the ones that you want to add. Choose **Save** when you're done.
106
96
107
-
:::image type="content" source="media/github-ent/ads-add-ghe-repositories.png" alt-text="Screenshot of repositories to select to add.":::
97
+
:::image type="content" source="media/github-ent/ads-add-ghe-repositories.png" alt-text="Screenshot of repositories to select to add.":::
108
98
109
99
3. To connect to a GitHub account or organization from Azure Boards for the first time, you also install the Azure Boards app for GitHub. Complete the integration by following the procedures outlined in [Confirm the connection](connect-to-github.md#confirm-connection).
110
100
@@ -113,7 +103,7 @@ You can connect up to 250 GitHub repositories to an Azure Boards project.
113
103
The Azure Boards-GitHub integration relies on various authentication protocols to support the connection. Changes to a user's permission scope or authentication credentials can cause revocation of the GitHub repositories connected to Azure Boards.
114
104
115
105
For an overview of the integration that the Azure Boards app for GitHub supports, see [Azure Boards-GitHub integration](index.md).
116
-
106
+
<!--
117
107
#### Supported authentication options
118
108
119
109
The following authentication options are supported based on the GitHub platform you want to connect to.
@@ -170,33 +160,27 @@ The following authentication options are supported based on the GitHub platform
When the Azure Boards connection to GitHub no longer has access, it shows an alert status in the user interface with a red-X. Hover over the alert and it indicates that the credentials are no longer valid. To correct the problem, remove the connection and recreate a new connection.
179
166
180
167
:::image type="content" source="media/troubleshoot/failed-connection.png" alt-text="Screenshot of failed connection.":::
181
-
182
-
::: moniker-end
183
168
184
-
185
169
Consider the following resolutions:
186
170
187
171
-**If the connection is using OAuth**:
188
-
- The Azure Boards application had its access denied for one of the repositories.
172
+
- The Azure Boards application had access denied for one of the repositories.
189
173
- GitHub might be unavailable/unreachable. This unavailability could be because of an outage in either service or an infrastructure/network issue on-premises. You can check service status from the following links:
190
174
-[GitHub](https://status.github.com)
191
175
-[Azure DevOps](https://status.dev.azure.com/)
192
176
193
177
Delete and recreate the connection to the GitHub repository. This recreated connection causes GitHub to prompt to reauthorize Azure Boards.
194
178
195
-
-**If the connection is using a PAT:**
196
-
- The PAT was revoked or the required permission scopes changed and are insufficient.
179
+
-**If the connection is using a GitHub PAT:**
180
+
- The GitHub PAT was revoked or the required permission scopes changed and are insufficient.
197
181
- The user perhaps lost administrative permissions on the GitHub repository.
198
182
199
-
Recreate the PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`. For more information, see [Best practices for using PATs](../../organizations/accounts/use-personal-access-tokens-to-authenticate.md#best-practices-for-using-pats).
183
+
Recreate the GitHub PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`.
0 commit comments