How to enable the GitHub integration

Overview

You can enable the GitHub integration for your Tettra account through the team integrations page.

GitHub is installed at the team level, so everyone can use it once the integration is enabled. Only a GitHub admin may install the integration, and this person must also be a Tettra editor or Admin (i.e., not a Guest or Read-only user).

Process

Step 1. Go to your account and click your team's name to access the dropdown menu. Click Team integrations.

Step 2. Once the integration page appears, scroll down and click Connect your GitHub Org.

Step 3. This will take you to the GitHub app installation flow. Click Install.

Step 4. On the confirmation screen, choose your GitHub account and log in, then select the repositories you'd like to give Tettra access to. Click Install.

The permissions Tettra requires from GitHub are:

  • Read access to metadata
  • Read and write access to issues

These permissions allow Tettra to search for issues and their content since GitHub doesn't allow any access to code. We also request write access to issues so that we can backlink from them to the Tettra page.

Step 5. After selecting your repositories and clicking install, you'll be redirected back to the integrations page. You can go back anytime to edit which repositories are connected (or uninstall completely, should you wish).

Related