> For the complete documentation index, see [llms.txt](https://docs.nullify.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nullify.ai/connectors/github.md).

# GitHub

## Overview

Install the Nullify GitHub App to connect Nullify to your repositories. Nullify works with GitHub.com and GitHub Enterprise. Installation instructions differ for cloud and self-hosted deployments — see the [Enterprise Tier](https://docs.nullify.ai/getting-started/install/github-install.md) section for step-by-step guides.

In **Settings → Connectors → GitHub**, **Install GitHub App** opens the app on GitHub so you can choose your organization and repositories. Once connected, **Manage on GitHub** opens the installation to change repository access or approve permission updates.

Nullify posts updates asynchronously so developers stay inside their existing workflow.

## What Nullify does with GitHub

* **Pull request reviews.** When a pull request is opened, reopened, or updated, Nullify reviews the changed code and posts its findings back to the pull request as review comments and a **Nullify** check. When a PR is merged or closed, Nullify reconciles the state of any of its own autofix pull requests.
* **Push scanning.** Pushes are scanned, and pushes to the default branch refresh the repository's baseline so dashboards and finding counts stay current.
* **Autofix pull requests.** Nullify opens fix PRs for eligible findings, keeps them green through CI, responds to review comments, and assigns reviewers. See [Remediations](https://docs.nullify.ai/capabilities/remediations.md).
* **Comment-driven discussion.** Replies on a Nullify pull request — or an `@mention` of Nullify on any PR — are routed back so it can respond in-line.

## Events handled

Nullify subscribes to the events it needs to review and remediate — including push, pull-request, pull-request-review, review-comment and review-thread, issues and issue-comment, commit-comment, check-run and check-suite, status, repository, and the app installation lifecycle. Settings such as the CI/PR gate, ticketing thresholds, and notification destinations are configured in the Nullify dashboard under **Settings**, not in a file in your repository.

## Permissions

The Nullify GitHub App requests these permissions. The GitHub connector in **Settings → Connectors** lists the installation's permissions, flags any that are missing or granted below the expected level, and offers **Check permissions again** after you approve a change on GitHub.

| Permission             | Access       | Used for                                                                                                                                                                |
| ---------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Contents               | Read & write | Reading code and committing fixes to fix branches                                                                                                                       |
| Pull requests          | Read & write | Reviews and autofix pull requests                                                                                                                                       |
| Checks                 | Read & write | The **Nullify** check                                                                                                                                                   |
| Issues                 | Read & write | [GitHub Issues](#github-issues) ticketing                                                                                                                               |
| Commit statuses        | Read-only    | CI build status from other providers, such as [Buildkite](https://docs.nullify.ai/connectors/buildkite.md) and [Jenkins](https://docs.nullify.ai/connectors/jenkins.md) |
| Actions                | Read-only    | Reading failed GitHub Actions jobs so autofix can fix CI                                                                                                                |
| Metadata               | Read-only    | Set automatically by GitHub                                                                                                                                             |
| Members (organization) | Read-only    | Reading teams                                                                                                                                                           |
| Workflows              | Read & write | Only fixes that change GitHub Actions workflow files                                                                                                                    |

Without Workflows write access, and when no other installation issue is flagged, the GitHub card shows **Workflow fixes need access**. If GitHub shows a pending permission request for the App, an organization or account owner can approve it; otherwise the App owner has to add the permission first.

## Support

If you encounter any issues, please contact our support team for assistance.

## GitHub Issues

GitHub Issues can be a ticketing destination as well as a source-control feature. Nullify can create, assign, close, and reopen linked issues; issue lifecycle webhooks synchronize state back to the platform. The GitHub App must have the required issue permissions and subscribe to the `issues` event as well as `issue_comment`.

Configure the destination repository and routing policy before enabling automatic ticket creation. Closing an issue does not independently prove the underlying vulnerability has been remediated.

## Connection settings preview

The following sample shows the GitHub connection and permission diagnostics. Repository access is managed on GitHub; scan enrollment is configured separately in Nullify.

<figure><picture><source srcset="https://3946391995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FId2OtLCL6O6V3XSRYxtr%2Fuploads%2Fgit-blob-e979cbf69f646114d32ea10fc96fe6a1f17abbaa%2Fgithub-setup-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://3946391995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FId2OtLCL6O6V3XSRYxtr%2Fuploads%2Fgit-blob-1fccfd84a034f55470b83633ab658136e699d47a%2Fgithub-setup.png?alt=media" alt="Sample GitHub connection diagnostics"></picture><figcaption></figcaption></figure>
