Skip to content

Prerequisites for connecting a GitHub repository to the Data Productivity Cloud

Connecting a GitHub repository to the Data Productivity Cloud is a multi-step process with certain prerequisite actions. Read on to learn what steps you need to take a successful connection.

Note

You may need to confirm with your GitHub account admin/owner that you can install the Matillion GitHub app and create a repository.

1 - Install the Matillion app in your GitHub organization

You need to install the Matillion app in the GitHub organization that will host the repository that will be connected to your Designer project. To do this, follow the steps at Installing the Matillion Data Productivity Cloud app in GitHub.

To confirm that the Matillion app has been installed in the correct organization, visit https://github.com/organizations/<your-org-name>/settings/installations (replace <your-org-name with the org name in your GitHub URL).

2 - Create a new GitHub repository

In the GitHub organization you wish to install the Matillion app on, create a new repository. Initialize the repository by adding a README file. This will automatically set main as the default branch. It is advised to not rename this branch.

Want to use an existing repo?

If you already have an existing GitHub repository, you can connect that repository to your Data Productivity Cloud project, too. Once you complete the authorization between GitHub and Matillion, you'll see your existing repositories in the Project repository drop-down menu. If you choose an existing repository, all existing branches will be visible in your branch list in the Branches tab.

3 - Set up GitHub repository roles

The user connecting a GitHub repository to a Data Productivity Cloud project will need at least the Write GitHub repository role to actively work on data pipelines in Designer via the GitHub repository.

When you create an internal repository, all members of your GitHub org will have a base role that can be either Read, Triage, Write, Maintain, or Admin. If the base role is not Write, make sure to add users to your repository that have the Write role

If you created a private repository, you will need to add members of your GitHub org to your repository and grant them the Write role.

Read Repository roles for organizations to learn more about roles in GitHub.

4 - Set up project access in Designer (optional)

If you wish to collaborate with other Hub users on the same project, add them to your project by following the instructions at Access. Make sure these users are members of the same GitHub organization where the Matillion app is installed and where you created the repository that you connected to your project.