Get started with Git integration

This article walks you through the following basic tasks in Microsoft Fabric’s Git integration tool:

• Connect to a Git repo
• Commit changes
• Update from Git
• Disconnect from Git

We recommend reading the overview of Git integration before you begin.

Prerequisites

To integrate Git with your Microsoft Fabric workspace, you need to set up the following prerequisites for both Fabric and Git.

Fabric prerequisites

To access the Git integration feature, you need a Fabric capacity. A Fabric capacity is required to use all supported Fabric items. If you don't have one yet, sign up for a free trial. Customers that already have a Power BI Premium capacity, can use that capacity, but keep in mind that certain Power BI SKUs only support Power BI items.

In addition, the following tenant switches must be enabled from the Admin portal:

• Users can create Fabric items - require in case of Fabric artifacts use
• Users can synchronize workspace items with their Git repositories
• Create workspaces (only if you want to branch out to a new workspace.)
• Users can synchronize workspace items with GitHub repositories: For GitHub users only

These switches can be enabled by the tenant admin, capacity admin, or workspace admin, depending on your organization's settings.

Git prerequisites

Git integration is currently supported for Azure DevOps and GitHub. To use Git integration with your Fabric workspace, you need the following in either Azure DevOps or GitHub:

Azure DevOps

• An Active Azure DevOps account registered to same Fabric user (supported even if Azure DevOps organization reside in a different tenant than Fabric tenant). Create a free account.
• Access to an existing repository.

GitHub

• An active GitHub account. Create a GitHub account.

• One of the following personal access tokens:

  • A fine-grained token (recommended) with Contents read and write permission under the repository permissions:

    

    To use this token with GitHub Enterprise, follow these directions.

  • A Create a GitHub classic token with repo scopes enabled:

    

Connect a workspace to a Git repo

Connect to a Git repo

Only a workspace admin can connect a workspace to a repository, but once connected, anyone with permission can work in the workspace. If you're not an admin, ask your admin for help with connecting. To connect a workspace to an Azure or GitHub Repo, follow these steps:

1. Sign into Fabric and navigate to the workspace you want to connect with.

2. Go to Workspace settings

   

3. Select Git integration.

4. Select your Git provider. Currently, Azure DevOps and GitHub are supported.

Azure DevOps Connect

If you select Azure DevOps, select Connect to automatically sign into the Azure Repos account registered to the Microsoft Entra user signed into Fabric.

If you have already signed in to Azure from Fabric using a different account, select your account from the list and select Connect.

If it's your first time signing in from Fabric, or you want to add a new account, select Add account.

If it's the first time connecting, you need to Authorize your user. Provide the following information:

• Display name - must be unique for each user
• Azure DevOps URL - URL of the Azure DevOps repository. URL must be in the format https://dev.azure.com/{organization}/{project}/_git/{repository} or https://{organization}.visualstudio.com/{project}/_git/{repo}.
• Authentication - You can authenticate either with OAuth2 or a Service Principal. For more information see Azure DevOps - Git Integration with service principal

After you sign in, select Connect to allow Fabric to access your account

GitHub Connect

If you select GitHub, you need to sign in to your GitHub account. If you have already signed in to GitHub, select your account from the list and select Connect.

If it's your first time signing in from Fabric, or you want to add a new account, select Add account.

If it's the first time connecting, you need to Authorize your GitHub user. Provide the following information:

• Display name - must be unique for each GitHub user
• Personal access token - your classic or fine-grained personal access token
• Repository URL (optional for github.com, mandatory for ghe.com) - If you don't enter a URL, you can connect to any github.com repo you have access to. If you enter a URL, you can only connect to this repository.

After you sign in, select Connect to allow Fabric to access your GitHub account.

Connect to a workspace

If the workspace is already connected to Azure DevOps/GitHub, follow the instructions for Connecting to a shared workspace.

Azure DevOps branch connect

1. From the dropdown menu, specify the following details about the branch you want to connect to:

   • Organization
   • Project
   • Git repository.
   • Branch (Select an existing branch using the drop-down menu, or select + New Branch to create a new branch. You can only connect to one branch at a time.)
   • Folder (Type in the name of an existing folder or enter a name to create a new folder. If you leave the folder name blank, content is created in the root folder. You can only connect to one folder at a time.)

GitHub branch connect

1. From the dropdown menu, specify the following details about the branch you want to connect to:

   • Repository URL. If you connected to GitHub using a scoped token, the URL is automatically filled in and you can only connect to that repository.
   • Branch (Select an existing branch using the drop-down menu, or select + New Branch to create a new branch. You can only connect to one branch at a time.)
   • Folder (Type in the name of an existing folder or enter a name to create a new folder. If you leave the folder name blank, content is created in the root folder. You can only connect to one folder at a time.)

Select Connect and sync.

During the initial sync, if either the workspace or Git branch is empty, content is copied from the nonempty location to the empty one. If both the workspace and Git branch have content, you’re asked which direction the sync should go. For more information on this initial sync, see Connect and sync.

After you connect, the Workspace displays information about source control that allows the user to view the connected branch, the status of each item in the branch and the time of the last sync.

To keep your workspace synced with the Git branch, commit any changes you make in the workspace to the Git branch, and update your workspace whenever anyone creates new commits to the Git branch.

Commit changes to git

Once you successfully connect to a Git folder, edit your workspace as usual. Any changes you save are saved in the workspace only. When you’re ready, you can commit your changes to the Git branch, or you can undo the changes and revert to the previous status.

Read more about commits.

Commit to Git

To commit your changes to the Git branch, follow these steps:

1. Go to the workspace.

2. Select the Source control icon. This icon shows the number of uncommitted changes.

3. Select the Changes from the Source control panel. A list appears with all the items you changed, and an icon indicating if the item is new , modified , conflict , same change , or deleted .

4. Select the items you want to commit. To select all items, check the top box.

5. Add a comment in the box. If you don't add a comment, a default message is added automatically.

6. Select Commit.

   

After the changes are committed, the items that were committed are removed from the list, and the workspace points to the new commit that it synced to.

After the commit is completed successfully, the status of the selected items changes from Uncommitted to Synced.

Commit to standalone branch

Commit to standalone branch is a Git integration feature that lets you create a fresh branch and commit your current changes to it in one single action. In other words, instead of committing to the connected branch, you can branch off on the fly: the system will spin up a new Git branch and save your work there without requiring you to leave or switch from your original branch.

1. Go to the workspace.
2. Select the Source control icon. This icon shows the number of uncommitted changes.
3. Select the Changes from the Source control panel. A list appears with all the items you changed, and an icon indicating if the item is new , modified , conflict , same change , or deleted .
4. Select the items you want to commit. To select all items, check the top box.
5. Add a comment in the box. If you don't add a comment, a default message is added automatically.
6. Select Commit to new branch.

Important

Be aware of the following:

• the newly created branch won't be connected to the existing workspace.
• the newly created branch will be based on the last synch state of the current workspace.
• this functionality is possible when there are incoming updates - even if the default commit is disabled.
• the current workspace state won't be changed because of this commit and remains as is.

Undo saved change

After saving changes to the workspace, if you decide that you don’t want to commit those changes to git, you can undo the changes and revert those items to their previous status. To undo your changes, follow these steps:

1. Go to the workspace.

2. Select the Source control button. This button also shows the number of uncommitted changes.

3. Select Changes from the Source control panel. A list appears with all the items you changed, and an icon indicating if the changed item is new , modified , conflict , or deleted .

4. Select the changes you want to undo.

5. Place a check in the I understand that workspace items may be deleted and can't be restored box and select Undo.

   

6. Select Undo again to confirm. The dialog you see may vary depending on whether or not items that will be deleted are detected. The first screenshot shows no deletes. The second, if deletes are detected.

   

   

The selected items in your workspace revert to how they were when the workspace was last synced.

Important

If you delete an item and then undo the changes, the item is created a new and some of the metadata might be lost. For example, the sensitivity labels aren’t kept and should be reset, and the owner of the item is set to the current user.

Undoing added items will permanently delete the item.

Update workspace from Git

Whenever anyone commits a new change to the connected Git branch, a notification appears in the relevant workspace. Use the Source control panel to pull the latest changes, merges, or reverts into the workspace and update live items. Changes to folders are also updated. Read more about updating.

To update a workspace, follow these steps:

1. Go to the workspace.
2. Select the Source control icon.
3. Select Updates from the Source control panel. A list appears with all the items that were changed in the branch since the last update.
4. Select Update all.

5. On the confirmation dialog, select Update.

After it updates successfully, the list of items is removed, and the workspace points to the new workspace that it's synced to.

After the update is completed successfully, the status of the items changes to Synced.

Disconnect a workspace from Git

Only a workspace admin can disconnect a workspace from a Git Repo. If you’re not an admin, ask your admin for help with disconnecting. If you’re an admin and want to disconnect your repo, follow these steps:

1. Go to Workspace settings
2. Select Git integration
3. Select Disconnect workspace
4. Select Disconnect again to confirm.

Permissions

The actions you can take on a workspace depend on the permissions you have in both the workspace and the Git repo. For a more detailed discussion of permissions, see Permissions.

Related content

• Understand the Git integration process
• Manage Git branches
• Git integration best practices