Skip to content
This documentation applies to Codacy Self-hosted v5.1.0

For the latest updates and improvements, see the latest Cloud documentation instead.

GitHub Cloud#

Follow the instructions below to set up the Codacy Self-hosted integration with GitHub Cloud:

  1. Follow the instructions on creating a GitHub App.

  2. Edit the file values-production.yaml that you used to install Codacy.

  3. Set global.github.enabled: "true" and define the remaining values as described below using the information obtained when you created the GitHub App:

    github:
  enabled: "true"
  login: "true" # Show login button for GitHub Cloud
  clientId: "" # Client ID
  clientSecret: "" # Client secret
  app:
    name: "codacy" # GitHub App name
    id: "1234" # App ID
    privateKey: "" # Contents of the .pem file without newlines or the BEGIN/END lines

  4. Apply the new configuration by performing a Helm upgrade. To do so execute the command used to install Codacy:

    Important

    If you're using MicroK8s you must use the file values-microk8s.yaml together with the file values-production.yaml.

    To do this, uncomment the last line before running the helm upgrade command below.

    helm upgrade (...options used to install Codacy...) \
             --version 5.1.0 \
             --values values-production.yaml \
             # --values values-microk8s.yaml

After this is done you will be able to use GitHub Cloud to authenticate to Codacy.

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?

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

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 June 17, 2021