App Integration for Dedicated Cloud

Suggest Edits

The App Integration allows Codecov to:

  1. Provide login with functionality to end users
  2. Post comments and status on Pull Requests in
  3. Sync Codecov state to via webhooks
  4. For the user to provide fine grained controls for determining which repositories Codecov can access

Codecov needs several different values from the App Integration to enable the communication between your organization and your instance of the Dedicated Cloud.

  1. New Codecov App Client ID
  2. New Codecov App Client Secret
  3. New Codecov App App ID
  4. New Codecov App PEM (Private Key)
  5. New Codecov Webhook Secret

⚠️

On sharing Codecov app credentials

Please do not email or send unencrypted credentials. Please work with your Codecov representative or email [email protected] for one of several secure methods for sharing credentials.

A common method is to send credentials that have been encrypted using Codecov's public PGP Key.

There are 2 paths for creating the required App Integration

  1. Prefilled App Creation
  2. Manual App creation

🚧

Please ensure you have created the App following 1 of the methods above prior to continuing

Once the App is created, a Client ID will be generated automatically by . Additionally you will need to generate a new Client Secret and private key for the App in the user interface.

provides these 2 credentials by default on creation of the App.

Directly below the client id section of the App UI is the client secret section. Generate a new secret and copy the value for later transmission to your Codecov representative.

Near the bottom of the App UI, there is the option to generate a private key. This will allow you download a secret key (.pem file), which you will need to share with your Codecov representative. This is required for Codecov to properly authenticate and validate the author of the application.

Following the instructions above, you will now have all the credentials needed to allow Codecov to integrate with . The next step is to securely send your App credentials to your Codecov representative. Each required credential was called out above with instructions on how to obtain them. Please reach out with any questions.

Depending on your settings, you may have to install the Codecov App on any organizations that you wish to use it with. This can be done from the app settings screen. If you install the app prior to providing the app credentials to your Codecov representative, you may need to reinstall to ensure Codecov knows about your installation.

After setting up the app you can verify the installation on the organization's "Installed Apps" page.

  • 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 .com:
<your-codecov-url>/gh/<org-name>/><repo-name>/settings

For Enterprise:
<your-codecov-url>/ghe/<org-name>/><repo-name>/settings

Once there, check the " Webhook" section and press the "Create Web Hook" button if a webhook is not already set. Please send this value to your Codecov representative.

Updated over 1 year ago