Skip to content

Commit 9e32516

Browse files
committed
refresh, clarify GITHUB PATs
1 parent abc78fb commit 9e32516

File tree

1 file changed

+23
-38
lines changed

1 file changed

+23
-38
lines changed

docs/boards/github/connect-on-premises-to-github.md

Lines changed: 23 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.topic: how-to
77
ms.author: chcomley
88
author: chcomley
99
monikerRange: "<azure-devops"
10-
ms.date: 07/12/2023
10+
ms.date: 06/13/2025
1111
---
1212

1313
# Connect Azure DevOps Server to GitHub (on-premises)
@@ -16,13 +16,10 @@ ms.date: 07/12/2023
1616

1717
<!--- Supports https://go.microsoft.com/fwlink/?linkid=2095009 -->
1818

19-
::: moniker range="azure-devops-2020"
2019
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.
2120

2221
> [!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).
2623
2724
## Prerequisites
2825

@@ -34,46 +31,40 @@ When you connect your Azure DevOps Server project to your GitHub repositories, y
3431

3532
## Authentication options
3633

37-
The following authentication options are supported.
34+
The following authentication options are supported:
3835

39-
::: moniker range="azure-devops-2020"
40-
- [PAT](#server-github-ent-pat)
36+
- [GitHub PAT](#server-github-ent-pat)
4137
- [GitHub credentials](#server-github-ent-credentials)
4238

4339
> [!NOTE]
4440
> OAuth isn't supported for Azure DevOps Server 2020.
45-
::: moniker-end
4641
4742
<a id="github-oauth"></a>
4843
<a id="github-pat"></a>
4944
<a id="server-github-ent-oauth-register"></a>
5045

5146
## Connect Azure DevOps Server to GitHub Enterprise Server
5247

53-
::: moniker range="azure-devops-2020"
5448
You can connect up to 250 GitHub repositories to an Azure Boards project.
5549

50+
::: moniker range="azure-devops-2020"
5651
> [!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.
5954
::: moniker-end
6055

61-
62-
6356
1. Open the web portal for your Azure DevOps Server.
6457

6558
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.
6659

67-
::: moniker range="azure-devops-2020"
68-
6960
3. Select **Project settings** > **GitHub connections**.
7061

71-
:::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.":::
7263

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:
7465

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).
7768

7869
:::image type="content" source="media/github-ent/connect-github-account-first-time.png" alt-text="Screenshot of first time connecting with GitHub credentials.":::
7970

@@ -83,28 +74,28 @@ You can connect up to 250 GitHub repositories to an Azure Boards project.
8374
<a id="server-github-ent-pat"></a>
8475
<a id="github-ent-pat"></a>
8576

86-
#### Connect with a Personal Access Token
77+
## Connect Azure DevOps Server with a GitHub Personal Access Token
8778

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).
79+
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).
8980

9081
> [!TIP]
9182
> When you create your GitHub PAT, make sure that you include these scopes: `repo, admin:repo_hook, read:user, user:email`.
9283

9384
1. Enter the URL for your GitHub Enterprise server and the **Personal access token** credentials recognized by that server. And then select **Connect**.
9485

95-
:::image type="content" source="media/github-ent/ads-add-ghe-pat.png" alt-text="Screenshot of sign in with PAT.":::
86+
:::image type="content" source="media/github-ent/ads-add-ghe-pat.png" alt-text="Screenshot of sign in with GitHub PAT.":::
9687

9788
<a id="server-github-ent-credentials"></a>
9889

99-
#### Connect with GitHub credentials
90+
## Connect Azure DevOps Server with GitHub credentials
10091

10192
1. Enter the URL for your GitHub Enterprise server and the administrator account credentials recognized by that server. And then choose **Connect**.
10293

103-
:::image type="content" source="media/github-ent/ads-add-ghe-user-name.png" alt-text="Screenshot of sign in with GitHub credentials.":::
94+
:::image type="content" source="media/github-ent/ads-add-ghe-user-name.png" alt-text="Screenshot of sign in with GitHub credentials.":::
10495

10596
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.
10697

107-
:::image type="content" source="media/github-ent/ads-add-ghe-repositories.png" alt-text="Screenshot of repositories to select to add.":::
98+
:::image type="content" source="media/github-ent/ads-add-ghe-repositories.png" alt-text="Screenshot of repositories to select to add.":::
10899

109100
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).
110101

@@ -113,7 +104,7 @@ You can connect up to 250 GitHub repositories to an Azure Boards project.
113104
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.
114105

115106
For an overview of the integration that the Azure Boards app for GitHub supports, see [Azure Boards-GitHub integration](index.md).
116-
107+
<!--
117108
#### Supported authentication options
118109
119110
The following authentication options are supported based on the GitHub platform you want to connect to.
@@ -170,33 +161,27 @@ The following authentication options are supported based on the GitHub platform
170161
:::row-end:::
171162
172163
[!INCLUDE[temp](../includes/github-platform-support.md)]
173-
174-
#### Resolve access issues
175-
176-
::: moniker range=">= azure-devops-2020"
164+
-->
177165

178166
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.
179167

180168
:::image type="content" source="media/troubleshoot/failed-connection.png" alt-text="Screenshot of failed connection.":::
181-
182-
::: moniker-end
183169

184-
185170
Consider the following resolutions:
186171

187172
- **If the connection is using OAuth**:
188-
- The Azure Boards application had its access denied for one of the repositories.
173+
- The Azure Boards application had access denied for one of the repositories.
189174
- 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:
190175
- [GitHub](https://status.github.com)
191176
- [Azure DevOps](https://status.dev.azure.com/)
192177

193178
Delete and recreate the connection to the GitHub repository. This recreated connection causes GitHub to prompt to reauthorize Azure Boards.
194179

195-
- **If the connection is using a PAT:**
196-
- The PAT was revoked or the required permission scopes changed and are insufficient.
180+
- **If the connection is using a GitHub PAT:**
181+
- The GitHub PAT was revoked or the required permission scopes changed and are insufficient.
197182
- The user perhaps lost administrative permissions on the GitHub repository.
198183

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).
184+
Recreate the GitHub PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`.
200185

201186
<a id="update-wits"></a>
202187

0 commit comments

Comments
 (0)