Skip to content

Commit fe6f1df

Browse files
Freshness.
1 parent 6179baf commit fe6f1df

File tree

3 files changed

+39
-50
lines changed

3 files changed

+39
-50
lines changed

docs/boards/github/install-github-app.md

Lines changed: 39 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
---
2-
title: Install the Azure Boards app for GitHub
2+
title: Install the Azure Boards App for GitHub
33
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.
55
ms.service: azure-devops-boards
66
ms.topic: quickstart
77
ms.author: chcomley
88
author: chcomley
99
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.
1112
---
1213

1314
# Install the Azure Boards app for GitHub
1415

1516
[!INCLUDE [version-gt-eq-2020](../../includes/version-gt-eq-2020.md)]
1617

17-
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).
2021

2122
## Prerequisites
2223

@@ -26,59 +27,47 @@ For an overview of the integration that the Azure Boards app for GitHub supports
2627
| **Project membership**| [Project member](../../organizations/projects/create-project.md). |
2728

2829
> [!IMPORTANT]
29-
> 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.
3031
>
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.
3233
3334
## Install and configure the Azure Boards app
3435

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.
4037

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

43-
:::image type="content" source="media/github-app/choose-github-account.png" alt-text="Screenshot showing Install Azure Boards dialog.":::
40+
1. Under **Plans and pricing**, under **Free**, select **Install**.
4441

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**.
4643

47-
In the following example, we choose to connect to all repositories.
44+
This example uses **All repositories**:
4845

4946
:::image type="content" source="media/github-app/install-options.png" alt-text="Screenshot showing all repositories selected.":::
5047

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.
5249

5350
:::image type="content" source="media/github-app/choose-azure-boards-project.png" alt-text="Screenshot of setting up connection dialog.":::
5451

5552
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.
5653

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-
6554
<a id="get-started"></a>
6655

6756
## Give Azure Boards organization access
6857

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.
7059

7160
1. From the GitHub web portal, open **Settings** from your profile menu.
7261

7362
:::image type="content" source="media/troubleshoot/choose-settings.png" alt-text="Screenshot of open profile, choose Settings.":::
7463

75-
2. Select **Applications** under **Integrations**.
64+
1. Select **Applications** under **Integrations**.
7665

77-
3. Select **Authorized GitHub Apps** > **Azure Boards**.
66+
1. Select **Authorized GitHub Apps** > **Azure Boards**.
7867

7968
:::image type="content" source="media/troubleshoot/open-azure-boards.png" alt-text="Screenshot of Authorized OAuth Apps tab, choose Azure Boards.":::
8069

81-
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**.
8271

8372
:::image type="content" source="media/troubleshoot/organization-access-issues.png" alt-text="Screenshot of Organization access with organizations without access.":::
8473

@@ -92,30 +81,31 @@ At this point, your Azure Boards-GitHub integration is complete. You can skip th
9281

9382
A work item titled *Add badge to README* appears on your board.
9483

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**.
85+
1. From **Link type**, select **GitHub Pull Request**.
86+
1. Select the repository and enter the pull request ID and an optional comment.
87+
1. Select **Add link**.
9988

10089
:::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.":::
10190

102-
The following actions occur in the background, automatically:
91+
The following actions occur in the background, automatically:
92+
10393
- Adds a badge to the README file of the first repository in the list of connected GitHub repositories.
10494
- Creates a GitHub commit for the update made by adding the badge to the README file.
10595
- Creates a GitHub pull request to merge the changes made to the README file.
10696
- Links the GitHub commit and pull request to the work item created in step 1.
10797

108-
6. Select the first pull request link from your work item.
98+
1. Select the first pull request link from your work item.
10999

110100
:::image type="content" source="media/github-app/issue-add-badge.png" alt-text="Screenshot of issue form for pull request opened in GitHub.":::
111101

112102
The GitHub pull request opens in a new browser tab.
113103

114-
7. Select **Merge pull request**.
104+
1. Select **Merge pull request**.
115105

116106
:::image type="content" source="media/github-app/git-hub-pr-for-badge-b.png" alt-text="Screenshot of example pull request in GitHub.":::
117107

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.
119109

120110
:::image type="content" source="media/github-app/readme-file-with-badge.png" alt-text="Screenshot of GitHub repo with badge added.":::
121111

@@ -131,56 +121,55 @@ You can configure other Azure Boards/Azure DevOps Projects, GitHub.com repositor
131121

132122
## Add or remove repositories, or remove a connection from Azure Boards
133123

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.
135125

136126
::: moniker range=">= azure-devops-2020"
137127

138128
1. From your project in Azure DevOps, go to **Project settings** > **GitHub connections**.
139129

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.
141131

142132
:::image type="content" source="media/connect-cloud/connection-menu.png" alt-text="Screenshot of GitHub connection menu of More options.":::
143133

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.
145135

146136
:::image type="content" source="media/github/remove-connection-confirmation.png" alt-text="Screenshot of confirmation removal of GitHub connection.":::
147137

148138
::: moniker-end
149139

150140
## Change repository access
151141

152-
1. Sign into GitHub and open your organization profile settings.
142+
1. From the GitHub web portal, open **Settings** from your profile menu.
153143

154-
`https://github.com/organizations/fabrikam-fiber/settings/profile`
144+
1. Select **Integrations** > **Applications**. Under **Installed GitHub Apps**, select **Configure**.
155145

156-
2. Go to **Installed GitHub Apps** > **Azure Boards** > **Configure**.
157146
:::image type="content" source="media/change-repo-access/open-installed-github-apps.png" alt-text="Screenshot of open Organization account, Installed GitHub Apps, Azure Boards, Configure.":::
158147

159148
The Azure Boards configuration page opens.
160149

161-
3. Scroll down to the **Repository access** section.
150+
1. Scroll down to the **Repository access** section.
162151

163-
4. Choose the option you want, **All repositories** or **Only select repositories**.
152+
1. Choose the option you want, **All repositories** or **Only select repositories**.
164153

165154
If you choose **Only select repositories**, select the repositories you want to participate in integration with Azure Boards.
166155

167156
:::image type="content" source="media/change-repo-access/choose-repositories.png" alt-text="Screenshot of Repository access, choose Only select repositories.":::
168157

169-
5. Select **Save**.
158+
1. Select **Save**.
170159

171160
## Suspend or uninstall Azure Boards integration
172161

173162
1. Starting from step 2 in the previous procedure, scroll down to the **Danger zone** section.
174163

175164
:::image type="content" source="media/change-repo-access/danger-zone.png" alt-text="Screenshot of Azure Boards configuration, Danger zone section.":::
176165

177-
1. To suspend the integration, choose **Suspend**. From the popup confirmation window, choose **OK** to confirm the suspension.
166+
1. To suspend the integration, choose **Suspend**. From the confirmation window, choose **OK** to confirm the suspension.
178167

179168
:::image type="content" source="media/change-repo-access/suspend-confirmation-popup.png" alt-text="Screenshot of suspension confirmation.":::
180169

181-
To unsuspend the integration, choose **Unsuspend**.
170+
To unsuspend the integration, choose **Unsuspend**.
182171

183-
1. To uninstall the Azure Boards app, choose **Uninstall**, and then choose **OK** from the popup confirmation window.
172+
1. To uninstall the Azure Boards app, choose **Uninstall**, and then choose **OK** from the popup confirmation window.
184173

185174
:::image type="content" source="media/change-repo-access/uninstall-confirmation-popup.png" alt-text="Screenshot of uninstall confirmation.":::
186175

-27.4 KB
Loading
-838 Bytes
Loading

0 commit comments

Comments
 (0)