Creating a GitHub App¶

You must create and correctly set up a GitHub App to allow Codacy to integrate with GitHub.

To create the GitHub App:

If you're using GitHub Cloud, open https://github.com/settings/apps/new.

If you're using GitHub Enterprise, open https://github.example.com/settings/apps/new, replacing the HTTP protocol and hostname with the correct values for your GitHub Enterprise instance.

Configure the new GitHub App using the values listed on the table below, replacing https://codacy.example.com with the correct base URL of your Codacy instance.

Field	Value
GitHub App name	Codacy
Homepage URL	`https://codacy.example.com`
User authorization callback URL	`https://codacy.example.com`
Webhook URL	`https://codacy.example.com/2.0/events/gh/organization`
Repository permissions
Administration	Read & write
Checks	Read & write
Issues	Read & write
Metadata	Read only
Pull requests	Read & write
Webhooks	Read & write
Commit statuses	Read & write
Organization permissions
Members	Read only
Webhooks	Read & write
User permissions
Email addresses	Read only
Git SSH keys	Read & write
Where can this GitHub App be installed?	Any account

Scroll to the bottom of the page, click Generate a private key, and save the .pem file containing the private key.
Take note of the following information, as you'll need it to configure Codacy:
- GitHub App name
- App ID
- Client ID
- Client secret
- Private key (contents of the .pem file generated in the previous step)

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

255 characters left

We're sorry to hear that. Please let us know what we can improve:

255 characters left

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help please contact support@codacy.com.

Last modified April 27, 2020