Git integration with paginated reports

APPLIES TO: Power BI service Power BI Report Builder Power BI Desktop

This article walks you through publishing a paginated report and keeping it in sync with your git workspace. Developers can apply their development processes, tools, and best practices.

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 one of the following:

• Power BI Premium license. A Power BI premium license supports all Power BI items only.
• 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.

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

• Users can create Fabric items
• Users can synchronize workspace items with their Git repositories
• For GitHub users only: Users can synchronize workspace items with GitHub repositories

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 account registered to the same user that is using the Fabric workspace. 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:

    

Read about the integration of Git with Microsoft Fabric at Introduction to git integration.

Power BI prerequisites

See the Prerequisites section in Get started creating paginated reports in the Power BI service.

Add a paginated report to GitHub

1. Connect your workspace to your git repository by following the directions in Connect a workspace to an Azure repo.

   

   Note

   If the branch is new, you're prompted to Create and sync.

2. Upload your .rdl file to the workspace on the service. We don't support OneDrive or Sharepoint yet.

   

   After you upload the file, you should see the report and the Git status Uncommitted and Source control.

   

3. Select Source Control. In the source control pane, select the file and commit.

   

   After you commit the file, the Git status changes to Sync.

   

   A folder appears in your git repository that contains the .rdl and two .json files. You might have to refresh your repository.

   

Edit a paginated report that's saved to GitHub

1. Open the .rdl file from the local git repository in Power BI Report Builder.
2. Make the desired edits.
3. Commit and push your changes to the remote repository.
4. Create a PR to the main branch.
5. Once approved, the PR is merged to the main branch.
6. From the main branch, apply your revised changes to the relevant workspace.

Considerations and limitations

• Publish/upload the paginated report to the service and then use git. Paginated reports don't render if you start with the files in git.

• When you delete a paginated report from git, delete the entire folder and not just the .rdl report.

• Renaming a paginated report in git doesn't work. However, renaming the .rdl on the Power BI service does work. If you do want to rename the paginated report, you must delete the paginated report from git, delete the entire folder, and recreate the folder with the .rdl with the new name.

• The paginated report remains connected to the original dataset when you move it to a different workspace. If you move a paginated report to a different workspace, update the dataset in Power BI Report Builder and republish the paginated report to the Power BI service.

Next steps

• Introduction to git integration