GitHub integration {#github}

Git repositories are the centerpiece of the vast majority of software projects out there. We integrate with GitHub to provide Tuist insights right in your pull requests and to save you some configuration such as syncing your default branch.

Setup {#setup}

You will need to install the Tuist GitHub app in the Integrations tab of your organization:

After that, you can add a project connection between your GitHub repository and your Tuist project:

[!TIP] Ip Allowlisting

If your GitHub organization uses IP allow lists or your GitHub instance is behind a firewall, make sure to allowlist Tuist's <.localized_link href="/guides/server/network#outbound-ip-addresses">outbound IP addresses</.localized_link> so that the integration can communicate with your repository.

Pull/merge request comments {#pull-merge-request-comments}

The GitHub app posts a Tuist run report, which includes a summary of the PR, including links to the latest <.localized_link href="/guides/features/previews#pullmerge-request-comments">previews</.localized_link> or <.localized_link href="/guides/features/selective-testing#pullmerge-request-comments">tests</.localized_link>:

[!NOTE] Requirements

The comment is only posted when your CI runs are <.localized_link href="/guides/integrations/continuous-integration#authentication">authenticated</.localized_link>.

[!NOTE] Github_ref

If you have a custom workflow that's not triggered on a PR commit, but for example, a GitHub comment, you might need to ensure that the GITHUB_REF variable is set to either refs/pull/<PR_NUMBER>/merge or refs/pull/<PR_NUMBER>/head.

You can run the relevant command, like tuist share, with the prefixed GITHUB_REF environment variable: <code v-pre>GITHUB_REF="refs/pull/${{ github.event.issue.number }}/head" tuist share</code>