Prerequisites for connecting a GitLab repository to the Data Productivity Cloud
Connecting a GitLab cloud repository to the Data Productivity Cloud is a straightforward process. Read on to learn what steps are required.
Note
These setup steps detail what is required to connect a GitLab cloud project to the Data Productivity Cloud. While it may be possible to connect using a GitLab self-managed instance, this is not yet officially supported.
1. Create a new GitLab repository (optional)
Once signed in to your GitLab account, create a new project in your preferred group/sub-group. We strongly recommend also initializing the repository with a README file. The repository for the project will be created with main as the default branch.
Note
A branch called main is required, but it does not have to be the default branch.
Want to use an existing repository?
If you already have an existing GitLab repository, you can connect it to your Data Productivity Cloud project, too.
Once you complete the authorization process between GitLab and Matillion, you will see any existing repositories in the groups and sub-groups that you have the permission to view the source code of.
Warning
For users with access to a large number (> 100) of repositories, this may take a short while to load. This is a known degradation, with improvements actively being worked on to mitigate the issue.
If you choose an existing repository to connect to the Data Productivity Cloud, then all existing branches will be visible in your branch list in the Branches tab.
2. Set up GitLab project roles and permissions
There are numerous ways to control access of users to your GitLab projects, whether that is through the readily available roles offered by GitLab that provide collections of permissions to a user, or by defining custom roles if you need more fine-grained control.
This is not intended to be a primer on GitLab access control; however, you can read more about GitLab Roles and Permissions in the GitLab documentation.
If your organization is using the roles provided by GitLab, then for a user to be able to select a GitLab repository as a destination in the Data Productivity Cloud, they will need to be assigned at least the Developer GitLab role or above. The only repositories exposed for selection are those that a user has write access to, meaning any custom roles will need to grant write permissions to the user.
3. Set up project access in Designer (optional)
If you wish to collaborate with other Data Productivity Cloud users on the same project, add them to your project by following the instructions at Access. Make sure these users are either members of the same GitLab group that contains the GitLab project you have connected to your Matillion project, or that they have been invited and assigned an appropriate role in GitLab if they are a user that is external to your organization.