Installing the Matillion Maia app in GitHub🔗
Editions
This feature is available to customers on specific editions. Visit Matillion pricing to learn more about each edition.
Read Prerequisites for connecting a GitHub repository to Maia before installing the app.
How to install the app🔗
- Log in to GitHub.
- Navigate to the Matillion for GitHub app page.
- Make sure you are about to install the app in your company's organization account and not your personal GitHub account, and then click Install.
- Select All repositories or Only select repositories.
- If you select All repositories, you can choose any current or new repos in your GitHub organization when you create a new project in Maia.
- If you select Only select repositories, choose the repository that you created for the sole purpose of developing your Designer pipelines.
Note
We recommend that you choose Only select repositories to allow access only to repositories that you intend to use with Maia. If you select this option and then create new repositories in GitHub, you'll need to grant access to these new repositories if you want to connect them to Maia. To do this, visit https://github.com/organizations/<your-org-name>/settings/installations (replacing "your-org-name" with your organization name) and click Configure. From this page, you can view the list of repositories that the Matillion GitHub app has access to. If no repositories are selected, create a repository in that organization first, and then create a project in Maia.
Once the Matillion Maia app is installed in your organization's GitHub account, you can create your project in Designer and connect your project to the GitHub repository.
One-time installation🔗
You only need to install the Matillion Maia app in your GitHub organization account once. After this, whenever you create a new project in Maia, you can connect to any repositories that you grant Maia access to.
If you wish to revoke or change Designer's access to your repositories, go to https://github.com/organizations/<your-org-name>/settings/installations (change <your-org-name> to the organization in your GitHub URL) and click Configure.
Required GitHub App permissions🔗
When installing or using the Matillion App for GitHub (BYOG), the following repository permissions are required:
- Read and write access to Contents: Repository contents, commits, branches, downloads, releases, and merges.
- Read and write access to Workflows: GitHub Actions workflow files under
.github/workflows/.
These permissions enable Maia to commit changes, manage branches, and update GitHub Actions workflows in your repository.
Note
If the GitHub App is already installed, GitHub will notify organization administrators to approve the additional Workflows permission. If this permission is not approved, the integration continues to function, but Maia cannot modify GitHub Actions workflow files.