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.comwith the correct base URL of your Codacy instance.
Field Value GitHub App name Codacy Homepage URL
User authorization callback URL
Expire user authorization tokens Disabled Webhook URL For GitHub Cloud:
For GitHub Enterprise:
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
.pemfile 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
.pemfile generated in the previous step)