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.

You can install a free plan from the GitHub Marketplace or perform the private app installation detailed below.

Install Nullify

Step 1: Setting up your GitHub application

Refer to GitHub's documentation on creating a GitHub App for general guidance on setting up your application. Configure your application with the following details:

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

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

GitHub App name

Homepage URL

Webhook URL

Identifying and authorizing users:

• Add the Callback URL

• Enable Request user authorization (OAuth) during installation

• Enable Device Flow

Webhook:

• Add the Webhook URL

• Add the Webhook secret (optional)

• Enable SSL verification

Display Information:

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

Nullify logo added to GitHub App display information

Grant access to the following Repository permissions:

Permission	Access	Explanation
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

Grant access to the following Organization permissions:

Permission	Access	Explanation
Members	Read	Read teams

If Repository Administration permissions are not provided, please ensure that you enable GitHub Issues within each repository that Nullify is installed

Also, 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

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

Navigate to Optional features and opt-out of the user-to-server token expiration feature

Step 2: Installing your GitHub application in your organization

Now, you must install your GitHub App in your organization and retrieve the App ID, client secret and private key. For further details, consult GitHub's documentation on installing GitHub Apps.

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

In General, generate a new Client secret.

In General, generate a private key:

Private key

In Install App, install the App in your organization:

Install App

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

Repository access