GitHub Install

Nullify is currently available as a GitHub App that can be installed across select repositories or all current and future repositories, allowing for organization-wide coverage in one click.

Please reach out to our team to assist with your org setup.

Install Nullify

Setting up your GitHub application

See creating a GitHub App for general guidance on setting up GitHub Apps.

1. Go to https://github.com/organizations/<insert-your-org-name>/settings/apps/new

2. GitHub App Name: Enter the name of your application.

3. Homepage URL: Enter https://nullify.ai

GitHub App name

Homepage URL

Webhook URL

1. Add the Callback URL

2. Enable Request user authorization (OAuth) during installation

3. Enable Device Flow

Webhook:

1. Add the Webhook URL

2. Add the Webhook secret

3. Enable SSL verification

Display Information:

1. Add the Nullify logo (amethyst only) available from https://nullify.ai/brand-kit

Nullify logo added to GitHub App display information

1. Grant access to the following Repository permissions:

Permission	Access	Explanation
Actions	Read-only	Read required for the auto-fix agent to fix failing CI jobs
Checks	Read & write	Write required to create and modify Check Runs
Contents	Read & write	Write required for creating and resolving comments
Issues	Read & write	Write required to create and modify Issues
GitHub.com: Metadata	Read-only	This setting is automatically set by GitHub
Pull Requests	Read & write	Write required to create and modify Pull Requests

1. Grant access to the following Organization permissions:

Permission	Access	Explanation
Members	Read	Read teams

1. Subscribe to the following Events:

Event Type	Subscription
Pull Request	Required
Push	Required
Check Run	Required
Issues	Required
Issue Comment	Required
Pull Request Review	Required
Pull Request Review Comment	Required
Pull Request Review Thread	Required

1. In the "Where can this GitHub App be installed?" section, select Only on this account. Then select Create GitHub App.

1. Navigate to the Developer settings of your new App. In General, get the App ID and Client ID.

GitHub App - Developer settings

App ID & Client ID

1. In General, generate a new Client secret.

2. In General, generate a private key:

Private key

1. Send the App ID, Client ID, Client Secret and Private Key to Nullify. This can be done via a password manager.

2. Wait for your stack to be provisioned..

3. In Install App, install the App in your organization:

Install App

1. In Repository access, select the repositories you would like to install Nullify:

Repository access