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/connect-to-github.md
+31-17Lines changed: 31 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
---
2
2
title: Connect an Azure Boards or Azure DevOps project to a GitHub repository
3
3
titleSuffix: Azure Boards
4
-
description: Configure one or more GitHub repositories to integrate with Azure Boards
4
+
description: Configure one or more GitHub repositories to integrate with Azure Boards.
5
5
ms.service: azure-devops-boards
6
6
ms.topic: how-to
7
7
ms.author: chcomley
8
8
author: chcomley
9
9
monikerRange: 'azure-devops'
10
-
ms.date: 07/03/2023
10
+
ms.date: 05/07/2024
11
11
---
12
12
13
13
# Connect Azure Boards to GitHub (cloud)
@@ -76,11 +76,11 @@ You can connect up to 500 GitHub repositories to an Azure Boards project.
76
76
77
77
2. Choose the GitHub account or organization that you want to connect. Only those organizations that you own or are an administrator for are listed.
78
78
79
-
If all repositories for an organization have already been connected to Azure Boards, you see the following message.
79
+
If all repositories for an organization are already connected to Azure Boards, you see the following message.
80
80
81
81
:::image type="content" source="media/connect-cloud/message-all-repositories-already-connected.png" alt-text="Screenshot of message where no more repositories exist to connect.":::
82
82
83
-
3. Enter your GitHub credentials. If you have two-factor authentication enabled, enter the authentication code that GitHub sent you and choose **Verify**. Otherwise, the system automatically recognizes your GitHub organization as your GitHub account has previously been associated with your Azure DevOps Services account.
83
+
3. Enter your GitHub credentials. If you have two-factor authentication enabled, enter the authentication code that GitHub sent you and choose **Verify**. Otherwise, the system automatically recognizes your GitHub organization as your GitHub account is associated with your Azure DevOps Services account.
84
84
85
85
<aid="choose-repositories"></a>
86
86
@@ -159,10 +159,10 @@ If you plan to use OAuth to connect Azure DevOps with your GitHub Enterprise Ser
159
159
160
160
:::image type="content" source="media/github-ent/ghe-settings-dev-oauth.png" alt-text="Screenshot showing sequence for New OAuth App.":::
161
161
162
-
3. Enter information to register your application.
162
+
3. Enter registration information.
163
163
164
-
For the <strong>Homepage URL</strong>, specify the <strong>Organization URL</strong> of your organization.
165
-
For the <strong>Authorization callback URL</strong>, use the following pattern to construct the URL.
164
+
For the **Homepage URL**, specify the **Organization URL** of your organization.
165
+
For the **Authorization callback URL**, use the following pattern to construct the URL.
3. Under **Organization access**, resolve any issues that may appear. Select **Grant** to grant access to any organizations that show as having an **Access request pending**.
323
+
3. 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**.
324
324
325
325
:::image type="content" source="media/troubleshoot/organization-access-issues.png" alt-text="Screenshot of Organization access with organizations without access.":::
326
326
@@ -341,30 +341,30 @@ To resolve this issue, consider the following items:
341
341
Delete and recreate the connection to the GitHub repository. This recreated connection causes GitHub to prompt to reauthorize Azure Boards.
342
342
343
343
-**If the connection is using a PAT:**
344
-
- The PAT may have been revoked or the required permission scopes changed and are insufficient.
345
-
- The user may have lost admin permissions on the GitHub repo.
344
+
- The PAT might be revoked or the required permission scopes changed and are insufficient.
345
+
- The user might not have admin permissions on the GitHub repo.
346
346
347
347
Recreate the PAT and ensure the scope for the token includes the required permissions: `repo, read:user, user:email, admin:repo_hook`.
348
348
349
349
<aid="ghe-dataimport"></a>
350
350
351
351
#### Resolve broken GitHub Enterprise Server connection
352
352
353
-
If you've migrated from Azure DevOps Server to Azure DevOps Services with an existing GitHub Enterprise Server connection, your existing connection won't work as expected. Work item mentions within GitHub may be delayed or never show up in Azure DevOps Services. This problem occurs because the callback url associated with GitHub is no longer valid.
353
+
If you migrated from Azure DevOps Server to Azure DevOps Services with an existing GitHub Enterprise Server connection, your existing connection doesn't work as expected. Work item mentions within GitHub might be delayed or never show up in Azure DevOps Services. This problem occurs because the callback URL associated with GitHub is no longer valid.
354
354
355
355
Consider the following resolutions:
356
356
357
357
-**Remove and re-create the connection**:
358
358
Remove and re-create the connection to the GitHub Enterprise Server repository. Follow the sequence of steps provided in [Connect from Azure Boards](connect-to-github.md#github-ent-oauth-services) documentation.
359
359
360
-
-**Fix the webhook url**:
361
-
Go to GitHub's repository settings page and edit the webhook url to point out to the migrated Azure DevOps Services organization url: ```https://dev.azure.com/{OrganizationName}/_apis/work/events?api-version=5.2-preview```
360
+
-**Fix the webhook URL**:
361
+
Go to GitHub's repository settings page and edit the webhook URL, pointing to the migrated Azure DevOps organization URL: ```https://dev.azure.com/{OrganizationName}/_apis/work/events?api-version=5.2-preview```
#### Connect to multiple Azure DevOps organizations
366
366
367
-
If you connect your GitHub repository to two or more projects that are defined in more than one Azure DevOps organization, such as dev.azure.com/Contoso and dev.azure.com/Fabrikam, you may get unexpected results when using **AB#** mentions to link to work items. This problem occurs because work item IDs aren't unique across Azure DevOps organizations, so **AB#12** can refer to a work item in either the Contoso or Fabrikam organization. So, when a work item is mentioned in a commit message or pull request, both organizations attempt to create a link to a work item with a matching ID (if one exists).
367
+
If you connect your GitHub repository to two or more projects that are defined in more than one Azure DevOps organization, such as dev.azure.com/Contoso and dev.azure.com/Fabrikam, you might get unexpected results when using **AB#** mentions linking to work items. This problem occurs because work item IDs aren't unique across Azure DevOps organizations, so **AB#12** can refer to a work item in either the Contoso or Fabrikam organization. When a work item gets mentioned in a commit message or pull request, both organizations can attempt to create a link to a work item with a matching ID if one exists.
368
368
369
369
In general, a user intends an **AB#** mention to link to a single work item in one of the projects. But, if a work item of the same ID exists in both accounts, then links get created for both work items, likely causing confusion.
370
370
@@ -377,7 +377,7 @@ Currently, there's no way to work around this issue, so we recommend that you co
377
377
378
378
#### Update XML definitions for select work item types
379
379
380
-
If your organization uses the Hosted XML or On-premises XML process model to customize the work tracking experience and you want to link to and view the GitHub link types from the Development section in the work item forms, you'll need to update the XML definitions for the work item types.
380
+
Update the XML definitions for the work item types, if your organization uses the Hosted XML or on-premises XML process model to customize the work tracking experience and you want to link to and view the GitHub link types from the Development section in the work item forms.
381
381
382
382
For example, if you want to link user stories and bugs to GitHub commits and pull requests from the **Development** section, you need to update the XML definitions for user stories and bugs.
383
383
@@ -389,7 +389,7 @@ Follow the sequence of tasks provided in [Hosted XML process model](../../organi
389
389
> <ExternalLinkFilterType="GitHub Commit" />
390
390
> ```
391
391
392
-
When it's updated, the section should appear as follows.
392
+
When updated, the section should appear as follows.
393
393
394
394
> [!div class="tabbedCodeSnippets"]
395
395
> ```XML
@@ -415,6 +415,20 @@ When it's updated, the section should appear as follows.
415
415
> </Group>
416
416
> ```
417
417
418
+
<aid="faqs"></a>
419
+
420
+
## FAQs (Frequently asked questions)
421
+
422
+
### Q: Some of my users in Azure DevOps have GitHub identities. Do I need to add them as new GitHub users into my organization?
423
+
A: No. Ask your users to sign out, and then from a fresh browser session, sign back in to the organization with their GitHub credentials. This action will help establish the users as having valid GitHub identities.
424
+
425
+
### Q: I'm an organization Administrator and I turned on the policy that enables inviting GitHub users. Why can't I invite new GitHub users?
426
+
A: Once the setting is changed, sign out of Azure DevOps, and then from a fresh browser session, sign back in to the organization `dev.azure.com/{organizationName}` or `organizationName.visualstudio.com` with your GitHub credentials.
427
+
428
+
### Q: I signed in with my GitHub credentials, but why can't I invite GitHub users?
429
+
430
+
A: Only organization or project Administrators can invite new users to join the organization. You might not have the permission required to add new users. Work with your administrator to get you the right permissions or ask them to add the user for you.
Copy file name to clipboardExpand all lines: docs/organizations/accounts/add-organization-users.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ To give other users access to your organization, add their email addresses.
67
67
> [!div class="mx-imgBorder"]
68
68
>
69
69
70
-
***Users:** Enter the email addresses (Microsoft accounts) or GitHub usernames for the users. You can add several email addresses by separating them with a semicolon (;). An email address appears in red when it's accepted. For more information about GitHub authentication, see [FAQs](../security/faq-github-authentication.yml). To add a service principal, enter the display name of the application or managed identity.
70
+
***Users:** Enter the email addresses (Microsoft accounts) or GitHub usernames for the users. You can add several email addresses by separating them with a semicolon (;). An email address appears in red when it's accepted. For more information about GitHub authentication, see [Connect to GitHub/FAQs](../../boards/github/connect-to-github.md#faqs). To add a service principal, enter the display name of the application or managed identity.
71
71
***Access level:** Leave the access level as **Basic** for users who contribute to the code base. To learn more, see [About access levels](../security/access-levels.md).
72
72
***Add to projects:** Select the project you want to add them to.
73
73
***Azure DevOps Groups:** Leave as **Project Contributors**, the default security group for users who contribute to your project. To learn more, see [Default permissions and access assignments](../security/permissions-access.md).
Copy file name to clipboardExpand all lines: docs/organizations/security/about-security-identity.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -228,7 +228,7 @@ The following policies determine the access you want to give users and applicati
228
228
-**External guest access** (*Only valid when the organization is connected to Microsoft Entra ID.*): When enabled, invitations can be sent to email accounts of users who aren't members of the tenant Microsoft Entra ID through the **Users** page. For more information, see [Add external users to your organization](../accounts/add-external-user.md).
229
229
-**Allow team and project administrators to invite new users**: Only valid when the organization is connected to Microsoft Entra ID. When enabled, team and project administrators can add users through the **Users** page. For more information, see [Restrict new user invitations from Project and Team Administrators](restrict-invitations.md).
230
230
-**Request access**: Only valid when the organization is connected to Microsoft Entra ID. When enabled, users can request access to a resource. A request results in an email notification to the administrators asking for review and access, as needed. For more information, see [Add external users to your organization](../accounts/add-external-user.md).
231
-
-**Invite GitHub users**: Only valid when the organization isn't connected to Microsoft Entra ID. When enabled, administrators can add users based on their GitHub user accounts from the **Users** page. For more information, see [Authenticating & inviting GitHub users FAQs](faq-github-authentication.yml#github-users).
231
+
-**Invite GitHub users**: Only valid when the organization isn't connected to Microsoft Entra ID. When enabled, administrators can add users based on their GitHub user accounts from the **Users** page. For more information, see [Connect to GitHub/FAQs](../../boards/github/connect-to-github.md#faqs).
0 commit comments