GitHub Integration Setup Guide

馃暀聽聽1 minute read

GitHub is a software development platform and offers version control management.

This integration enables all GitHub actions and the GitHub trigger within Catalytic, including our GitHub: Look up an issue and GitHub: Create an issue actions and the GitHub Trigger.

Integrations can only be set up by Admin users and are enabled per team. See our General Integration Information page for an overview of integrations and some recommendations when configuring new integrations.

Required Setup

Configuring with GitHub is simple and only requires logging in with the email address and password for your GitHub Account. Creating the integration is like signing into your GitHub account, which is a common sign in method for different sites and services.

Create Integration

  1. Open the overflow menu in the top navigation bar, and select Admin.
  2. Select Integrations at the bottom of the page.
  3. Select the Add an Integration button in the top right corner.
  4. Select the GitHub integration then select Add this Connection.
  5. Fill in the details. Set the integration permissions if necessary.
  6. Select Connect.
  7. If you are already signed into GitHub, you鈥檒l be asked to authorize the connection. If you鈥檙e not signed in, you鈥檒l just need to log in with the GitHub email address and password you wish to connect.
  8. After logging in, GitHub will ask you to authorize the connection. Catalytic only requires specific GitHub permissions at this time. These permissions enable Workflows to help automate mundane work in GitHub.
  9. After authorizing or logging into your GitHub account, the integration is ready to go and you鈥檒l be returned back to Catalytic.