GitHub

Connect GitHub when a workflow or an agent should work with your repositories: triage a new issue, comment on a pull request, or report when a GitHub Actions run finishes.

Who can connect it

An owner or admin connects GitHub once for the whole organization. A member asks one of them. Every workflow and agent then uses the same connection. See Connecting apps.

Connect GitHub

1. Open the Apps page.
2. Press Connect an app.
3. Choose GitHub in the Super Connect window.
4. Sign in to GitHub and approve the access it asks for. If GitHub asks where to install the app, choose the account or organization and the repositories Super Flows may reach.
5. Finish when the window reaches Done.

On the Apps page, the App column reads App installation when the connection is a GitHub App installation, and User account otherwise. Open the row to see the login, the installation and the scopes.

What you get

A GitHub connection brings actions and events. Actions work with issues, pull requests, files, code search and GitHub Actions workflow runs. Events start a run when something happens in a repository, such as a pull request opened or an issue opened. The live list of both is in the builder: the Action node’s picker for actions, and the Event list of an App event trigger for events. An agent uses only the actions you grant it. Action steps never offer a destructive action; an agent can be granted one, and it always waits for a member’s approval.

Good to know

• GitHub event filters match exactly. A repository is written as owner/name.
• Publishing creates the event subscription first. If GitHub refuses, for example because the connected account lacks admin access to the repository, the publish stops with that reason and nothing is saved.
• The Access column on the Apps page shows what the connection’s triggers watch, such as watching 1 repository.

Caution

A workflow can start itself again. A step that comments on an issue fires a trigger that listens for new issue comments in the same repository. Only your plan’s monthly run allowance stops such a loop, so add a Conditional step after the trigger that stops on comments the workflow wrote.

Reauthorize GitHub

When the connection’s health reads failing or needs reauthorization, an owner or admin opens the Apps page, presses … on its row, then Reauthorize, and signs in again. The connection stays the same, so workflows, triggers and agent grants need no change. See Reauthorize a connection.