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
Copy file name to clipboardExpand all lines: docs/boards/github/install-github-app.md
+39-50Lines changed: 39 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,23 @@
1
1
---
2
-
title: Install the Azure Boards app for GitHub
2
+
title: Install the Azure Boards App for GitHub
3
3
titleSuffix: Azure Boards
4
-
description: Learn how to configure the Azure Boards app to connect one or more GitHub repositories to Azure Boards, and change GitHub repo access.
4
+
description: Use this quickstart to configure the Azure Boards app to connect one or more GitHub repositories to Azure Boards, and change GitHub repo access.
5
5
ms.service: azure-devops-boards
6
6
ms.topic: quickstart
7
7
ms.author: chcomley
8
8
author: chcomley
9
9
monikerRange: "<=azure-devops"
10
-
ms.date: 03/01/2024
10
+
ms.date: 08/01/2025
11
+
#customer intent: As a team leader, I need to know how to install the Azure Boards app for GitHub to link our Boards experience to the GitHub repo functionality.
Install the Azure Boards app for GitHub to connect Azure Boards to your GitHub repositories. When you connect Azure Boards projects with GitHub.com 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.
18
-
19
-
For an overview of the integration that the Azure Boards app for GitHub supports, see [Azure Boards-GitHub integration](index.md). Once you install the Azure Boards app for GitHub on your GitHub account or organization, choose which GitHub repositories you want to connect to from your project.
18
+
In this quickstart, you install the Azure Boards app for GitHub to connect Azure Boards to your GitHub repositories. When you connect Azure Boards projects with GitHub.com 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. After you install the Azure Boards app for GitHub on your GitHub account or organization, choose which GitHub repositories you want to connect to from your project.
19
+
20
+
For an overview of the integration that the Azure Boards app for GitHub supports, see [Azure Boards-GitHub integration](index.md).
20
21
21
22
## Prerequisites
22
23
@@ -26,59 +27,47 @@ For an overview of the integration that the Azure Boards app for GitHub supports
> If your repository is already connected via another authentication type such as OAuth, you must remove that repository from your existing connection before you reconnect it by using the GitHub App. Follow the steps provided in [Add or remove GitHub repositories](#add-remove-repos) later in this article before you configure the GitHub App.
30
+
> If your repository is already connected by using another authentication type such as OAuth, you must remove that repository from your existing connection before you reconnect it by using the GitHub App. Follow the steps provided in [Add or remove GitHub repositories](#add-remove-repos) later in this article before you configure the GitHub App.
30
31
>
31
-
> You can connect an Azure DevOps organization to multiple GitHub repositories if you're an administrator for those repositories. However, you shouldn't connect a GitHub repository to more than one Azure DevOps organization.
32
+
> You can connect an Azure DevOps organization to multiple GitHub repositories if you're an administrator for those repositories. You shouldn't connect a GitHub repository to more than one Azure DevOps organization.
32
33
33
34
## Install and configure the Azure Boards app
34
35
35
-
1. Go to the Azure Boards app in the [GitHub Marketplace](https://github.com/marketplace/azure-boards).
36
-
37
-
2. Select **Set up a plan**.
38
-
39
-
:::image type="content" source="media/github-app/install-azure-boards-app-from-marketplace.png" alt-text="Screenshot of GitHub Marketplace, Set up a plan button.":::
36
+
Your installation sequence might vary due to your account configuration. If necessary, follow on screen prompts between the following steps.
40
37
41
-
3. Choose the GitHub organization you want to connect to Azure Boards.
38
+
1. Go to the Azure Boards app in the [GitHub Marketplace](https://github.com/marketplace/azure-boards).
1. Under **Plans and pricing**, under **Free**, select **Install**.
44
41
45
-
4. Choose the repositories that you want to connect to Azure Boards.
42
+
1. In **Install & Authorize Azure Boards**, choose the repositories that you want to connect to Azure Boards, then select **Install & Authorize**.
46
43
47
-
In the following example, we choose to connect to all repositories.
44
+
This example uses **All repositories**:
48
45
49
46
:::image type="content" source="media/github-app/install-options.png" alt-text="Screenshot showing all repositories selected.":::
50
47
51
-
5. Choose the Azure DevOps organization and Azure Boards project you want to connect to GitHub.com.
48
+
1. Choose the Azure DevOps organization and Azure Boards project you want to connect to GitHub.com.
52
49
53
50
:::image type="content" source="media/github-app/choose-azure-boards-project.png" alt-text="Screenshot of setting up connection dialog.":::
54
51
55
52
You can only connect one project at a time. If you have other projects you want to connect, you can do that later as described in [Configure other projects or repositories](#configure) later in this article.
56
53
57
-
6. To connect with GitHub.com, authorize your Azure Boards organization.
58
-
59
-
:::image type="content" source="media/github-app/authorize-azure-boards.png" alt-text="Screenshot of Azure Boards authorization dialog.":::
60
-
61
-
7. Confirm the GitHub.com repositories that you want to connect. Select each repository you want to connect to. Unselect any repositories that you don't want to participate in the integration.
62
-
63
-
:::image type="content" source="media/github-app/confirm-github-repos.png" alt-text="Screenshot of Confirm your GitHub repositories dialog.":::
64
-
65
54
<aid="get-started"></a>
66
55
67
56
## Give Azure Boards organization access
68
57
69
-
To grant GitHub access to your Azure DevOps organization, do the following steps.
58
+
If necessary, to grant GitHub access to your Azure DevOps organization, do the following steps.
70
59
71
60
1. From the GitHub web portal, open **Settings** from your profile menu.
72
61
73
62
:::image type="content" source="media/troubleshoot/choose-settings.png" alt-text="Screenshot of open profile, choose Settings.":::
74
63
75
-
2. Select **Applications** under **Integrations**.
64
+
1. Select **Applications** under **Integrations**.
4. Under **Organization access**, resolve any issues that might appear. Select **Grant** to grant access to any organizations that show as having an **Access request pending**.
70
+
1. Under **Organization access**, resolve any issues that might appear. Select **Grant** to grant access to any organizations that show as having an **Access request pending**.
82
71
83
72
:::image type="content" source="media/troubleshoot/organization-access-issues.png" alt-text="Screenshot of Organization access with organizations without access.":::
84
73
@@ -92,30 +81,31 @@ At this point, your Azure Boards-GitHub integration is complete. You can skip th
92
81
93
82
A work item titled *Add badge to README* appears on your board.
94
83
95
-
2. Open your work item, go to the **Development** section, and select **Add link**.
96
-
3. Select**GitHub Pull Request** from the **Link type** dropdown menu.
97
-
4. Select the repository and enter the pull request ID and an optional comment.
98
-
5. Select **Add link**.
84
+
1. Open your work item, go to the **Development** section, and select **Add link**.
1. Select the repository and enter the pull request ID and an optional comment.
87
+
1. Select **Add link**.
99
88
100
89
:::image type="content" source="media/troubleshoot/add-link-to-pull-request-2.png" alt-text="Screenshot of Add link action in user story, showing repository selection and empty boxes for input of pull request ID and optional comment.":::
101
90
102
-
The following actions occur in the background, automatically:
91
+
The following actions occur in the background, automatically:
92
+
103
93
- Adds a badge to the README file of the first repository in the list of connected GitHub repositories.
104
94
- Creates a GitHub commit for the update made by adding the badge to the README file.
105
95
- Creates a GitHub pull request to merge the changes made to the README file.
106
96
- Links the GitHub commit and pull request to the work item created in step 1.
107
97
108
-
6. Select the first pull request link from your work item.
98
+
1. Select the first pull request link from your work item.
109
99
110
100
:::image type="content" source="media/github-app/issue-add-badge.png" alt-text="Screenshot of issue form for pull request opened in GitHub.":::
111
101
112
102
The GitHub pull request opens in a new browser tab.
113
103
114
-
7. Select **Merge pull request**.
104
+
1. Select **Merge pull request**.
115
105
116
106
:::image type="content" source="media/github-app/git-hub-pr-for-badge-b.png" alt-text="Screenshot of example pull request in GitHub.":::
117
107
118
-
8. Go to your repository README file and view the badge that was added.
108
+
1. Go to your repository README file and view the badge that was added.
119
109
120
110
:::image type="content" source="media/github-app/readme-file-with-badge.png" alt-text="Screenshot of GitHub repo with badge added.":::
121
111
@@ -131,56 +121,55 @@ You can configure other Azure Boards/Azure DevOps Projects, GitHub.com repositor
131
121
132
122
## Add or remove repositories, or remove a connection from Azure Boards
133
123
134
-
If you encounter a problem with a connection, we recommend that you remove the connection and start over with a new connection.
124
+
If you encounter a problem with a connection, we recommend that you remove the connection and start over with a new connection.
135
125
136
126
::: moniker range=">= azure-devops-2020"
137
127
138
128
1. From your project in Azure DevOps, go to **Project settings** > **GitHub connections**.
139
129
140
-
2. To add or remove repositories, select the **More options** ellipses for the connection and choose **Add repositories** or **Remove repositories** from the menu.
130
+
1. To add or remove repositories, select the **More options** ellipses for the connection and choose **Add repositories** or **Remove repositories** from the menu.
141
131
142
132
:::image type="content" source="media/connect-cloud/connection-menu.png" alt-text="Screenshot of GitHub connection menu of More options.":::
143
133
144
-
3. To remove all repositories and the connection, choose the **Remove connection** option. Then, choose **Remove** to confirm.
134
+
1. To remove all repositories and the connection, choose the **Remove connection** option. Then, choose **Remove** to confirm.
145
135
146
136
:::image type="content" source="media/github/remove-connection-confirmation.png" alt-text="Screenshot of confirmation removal of GitHub connection.":::
147
137
148
138
::: moniker-end
149
139
150
140
## Change repository access
151
141
152
-
1.Sign into GitHub and open your organization profile settings.
142
+
1.From the GitHub web portal, open **Settings** from your profile menu.
0 commit comments