Skip to content

Commit b0de961

Browse files
authored
Merge pull request #216308 from Clare-Zheng82/1026_Update_source_control_doc_auth
[Supportability] - Update Author with GitHub integration section in Source control doc
2 parents d779552 + 7e5e33f commit b0de961

File tree

5 files changed

+30
-13
lines changed

5 files changed

+30
-13
lines changed
25 KB
Loading
59.1 KB
Loading
-107 KB
Loading
26.2 KB
Loading

articles/data-factory/source-control.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: nabhishek
77
ms.author: abnarain
88
ms.topic: conceptual
99
ms.custom: seo-lt-2019
10-
ms.date: 03/01/2022
10+
ms.date: 10/26/2022
1111
---
1212

1313
# Source control in Azure Data Factory
@@ -132,46 +132,52 @@ For more info about connecting Azure Repos to your organization's Active Directo
132132

133133
Visual authoring with GitHub integration supports source control and collaboration for work on your data factory pipelines. You can associate a data factory with a GitHub account repository for source control, collaboration, versioning. A single GitHub account can have multiple repositories, but a GitHub repository can be associated with only one data factory. If you don't have a GitHub account or repository, follow [these instructions](https://github.com/join) to create your resources.
134134

135-
The GitHub integration with Data Factory supports both public GitHub (that is, [https://github.com](https://github.com)) and GitHub Enterprise. You can use both public and private GitHub repositories with Data Factory as long you have read and write permission to the repository in GitHub. ADF’s GitHub enterprise server integration only works with [officially supported versions of GitHub enterprise server.](https://docs.github.com/en/[email protected]/admin/all-releases)
135+
The GitHub integration with Data Factory supports both public GitHub (that is, [https://github.com](https://github.com)), GitHub Enterprise Cloud and GitHub Enterprise Server. You can use both public and private GitHub repositories with Data Factory as long you have read and write permission to the repository in GitHub. ADF’s GitHub enterprise server integration only works with [officially supported versions of GitHub enterprise server.](https://docs.github.com/en/[email protected]/admin/all-releases)
136136

137137
> [!NOTE]
138138
> If you are using Microsoft Edge, GitHub Enterprise version less than 2.1.4 does not work with it. GitHub officially supports >=3.0 and these all should be fine for ADF. As GitHub changes its minimum version, ADF supported versions will also change.
139139
140140
### GitHub settings
141141

142+
:::image type="content" source="media/author-visually/github-configure-repository-pane.png" alt-text=" Screenshot showing GitHub Configure a repository pane.":::
143+
144+
:::image type="content" source="media/author-visually/use-github-enterprise-server-pane.png" alt-text="Screenshot showing GitHub Configure a repository using enterprise server pane.":::
145+
142146
:::image type="content" source="media/author-visually/github-integration-image2.png" alt-text="GitHub repository settings":::
143147

144148
The configuration pane shows the following GitHub repository settings:
145149

146150
| **Setting** | **Description** | **Value** |
147151
|:--- |:--- |:--- |
148152
| **Repository Type** | The type of the Azure Repos code repository. | GitHub |
149-
| **Use GitHub Enterprise** | Checkbox to select GitHub Enterprise | unselected (default) |
150-
| **GitHub Enterprise URL** | The GitHub Enterprise root URL (must be HTTPS for local GitHub Enterprise server). For example: `https://github.mydomain.com`. Required only if **Use GitHub Enterprise** is selected | `<your GitHub enterprise url>` |
151-
| **GitHub account** | Your GitHub account name. This name can be found from https:\//github.com/{account name}/{repository name}. Navigating to this page prompts you to enter GitHub OAuth credentials to your GitHub account. | `<your GitHub account name>` |
152-
| **Repository Name** | Your GitHub code repository name. GitHub accounts contain Git repositories to manage your source code. You can create a new repository or use an existing repository that's already in your account. | `<your repository name>` |
153-
| **Collaboration branch** | Your GitHub collaboration branch that is used for publishing. By default, it's main. Change this setting in case you want to publish resources from another branch. | `<your collaboration branch>` |
153+
| **Use GitHub Enterprise Server** | Checkbox to select GitHub Enterprise Server.| unselected (default) |
154+
| **GitHub Enterprise Server URL** | The GitHub Enterprise root URL (must be HTTPS for local GitHub Enterprise server). For example: `https://github.mydomain.com`. Required only if **Use GitHub Enterprise Server** is selected | `<your GitHub Enterprise Server URL>` |
155+
| **GitHub repository owner** | GitHub organization or account that owns the repository. This name can be found from https:\//github.com/{owner}/{repository name}. Navigating to this page prompts you to enter GitHub OAuth credentials to your GitHub organization or account. If you select **Use GitHub Enterprise Server**, a dialog box will pop out to let you enter your access token. | `<your GitHub repository owner name>` |
156+
| **Repository Name** | Your GitHub code repository name. GitHub accounts contain Git repositories to manage your source code. You can create a new repository or use an existing repository that's already in your account. Specify your GitHub code repository name when you select **Select repository**. | `<your repository name>` |
157+
|**Git repository link**| Your GitHub code repository link. Specify your GitHub code repository link when you select **Use repository link**. |`<your repository link>`|
158+
| **Collaboration branch** | Your GitHub collaboration branch that is used for publishing. By default, it's main. Change this setting in case you want to publish resources from another branch. You can also create a new collaboration branch here. | `<your collaboration branch>` |
159+
| **Publish branch** |The branch in your repository where publishing related ARM templates are stored and updated.| `<your publish branch name>`|
154160
| **Root folder** | Your root folder in your GitHub collaboration branch. |`<your root folder name>` |
155-
| **Import existing Data Factory resources to repository** | Specifies whether to import existing data factory resources from the UX authoring canvas into a GitHub repository. Select the box to import your data factory resources into the associated Git repository in JSON format. This action exports each resource individually (that is, the linked services and datasets are exported into separate JSONs). When this box isn't selected, the existing resources aren't imported. | Selected (default) |
156-
| **Branch to import resource into** | Specifies into which branch the data factory resources (pipelines, datasets, linked services etc.) are imported. You can import resources into one of the following branches: a. Collaboration b. Create new c. Use Existing | |
161+
| **Import existing resources to repository** | Specifies whether to import existing data factory resources from the UX authoring canvas into a GitHub repository. Select the box to import your data factory resources into the associated Git repository in JSON format. This action exports each resource individually (that is, the linked services and datasets are exported into separate JSONs). When this box isn't selected, the existing resources aren't imported. | Selected (default) |
162+
| **Import resource into this branch** | Specifies into which branch the data factory resources (pipelines, datasets, linked services etc.) are imported. | |
157163

158164
### GitHub organizations
159165

160166
Connecting to a GitHub organization requires the organization to grant permission to Azure Data Factory. A user with ADMIN permissions on the organization must perform the below steps to allow data factory to connect.
161167

162-
#### Connecting to GitHub for the first time in Azure Data Factory
168+
#### Connecting to public GitHub or GitHub Enterprise Cloud for the first time in Azure Data Factory
163169

164-
If you're connecting to GitHub from Azure Data Factory for the first time, follow these steps to connect to a GitHub organization.
170+
If you're connecting to public GitHub or GitHub Enterprise Cloud from Azure Data Factory for the first time, follow these steps to connect to a GitHub organization.
165171

166172
1. In the Git configuration pane, enter the organization name in the *GitHub Account* field. A prompt to login into GitHub will appear.
167173
1. Login using your user credentials.
168174
1. You'll be asked to authorize Azure Data Factory as an application called *AzureDataFactory*. On this screen, you will see an option to grant permission for ADF to access the organization. If you don't see the option to grant permission, ask an admin to manually grant the permission through GitHub.
169175

170176
Once you follow these steps, your factory will be able to connect to both public and private repositories within your organization. If you are unable to connect, try clearing the browser cache and retrying.
171177

172-
#### Already connected to GitHub using a personal account
178+
#### Already connected to public GitHub or GitHub Enterprise Cloud using a personal account
173179

174-
If you have already connected to GitHub and only granted permission to access a personal account, follow the below steps to grant permissions to an organization.
180+
If you have already connected to public GitHub or GitHub Enterprise Cloud and only granted permission to access a personal account, follow the below steps to grant permissions to an organization.
175181

176182
1. Go to GitHub and open **Settings**.
177183

@@ -187,6 +193,17 @@ If you have already connected to GitHub and only granted permission to access a
187193

188194
Once you follow these steps, your factory will be able to connect to both public and private repositories within your organization.
189195

196+
#### Connecting to GitHub Enterprise Server
197+
198+
If you connect to GitHub Enterprise Server, you need to use personal access token for authentication. Learn how to create a personal access token in [Creating a personal access token](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
199+
200+
> [!Note]
201+
> GitHub Enterprise Server is in your self-hosted private environment, so you need have full control on the firewall, network policies and VPN when you use this authentication. For more information, see [About GitHub Enterprise Server](https://docs.github.com/en/[email protected]/admin/overview/about-github-enterprise-server#about-github-enterprise-server).
202+
203+
:::image type="content" source="media/author-visually/use-github-enterprise-server-pane.png" alt-text="Screenshot shows GitHub Configure a repository using enterprise server pane.":::
204+
205+
:::image type="content" source="media/author-visually/github-enterprise-server-access-token.png" alt-text="Screenshot showing using enterprise server access token authentication.":::
206+
190207
### Known GitHub limitations
191208

192209
- You can store script and data files in a GitHub repository. However, you have to upload the files manually to Azure Storage. A Data Factory pipeline does not automatically upload script or data files stored in a GitHub repository to Azure Storage.

0 commit comments

Comments
 (0)