Not Using GitHub Enterprise?
If you are not using GitHub Enterprise, you have two options:
- Use our Team Bot.
- Create this GitHub App Integration and limit it to your organization.
Rather than using a Team Bot, a GitHub App Integration can be used in GitHub (Cloud or Enterprise) to efficiently onboard new teams to Codecov.
The App Integration will allow teams to add Codecov directly to their repositories via the GitHub user interface.
This integration is meant to be a replacement for the Team Bot for GitHub (Cloud or Enterprise). Using it will ensure that comments are posted to Pull Requests as Codecov, rather than a Team Bot user.
To create a GitHub App Integration for Codecov, first navigate to your GitHub Apps:
Choose "New GitHub App":
And fill out the relevant fields for app creation:
It's important to set the proper homepage and callback URLs. They should point to your Codecov Enterprise install as follows:
For the web hook URL:
You should provide a secret. Once provided, you will want to ensure that you properly provide the secret in the Codecov Enterprise codecov.yml. See:
The following screenshot shows all permissions needed by the app integration, as well as the relevant events. For visibility permissions with a greater setting than "No Access" have been emphasized in green.
Required repository permissions.
Required organization permissions
Required user permissions.
If you're not using GitHub Enterprise, make sure that you only publish this app for your organization.
- If you don't receive comments on Pull Requests for Repositories with the App Integration installed, visit the repo settings page for that particular repository on your Codecov Enterprise install:
For GitHub Enterprise:
Once there, check the "GitHub Webhook" section and press the "Create Web Hook" button if a webhook is not already set.
Updated about a month ago