Skip to main content

Add the Codacy integration

The integration gives Astrolabe a Codacy account API token. It is what the Codacy plugin reads: the grade of a component and its issues.

You do it once, as an administrator.

Before you start​

You need a Codacy account API token. In Codacy, you create it under your account › Access management › API tokens. This step was not checked on a live instance.

🔧 Add the integration​

  1. In the left sidebar, at the bottom, click Administration.

  2. Under PLATFORM, click Company connections.

  3. On the Codacy card, click Configure.

  4. Top right, click Add Token.

  5. Fill in the form:

    FieldWhat to enterExample
    NameA name for you, shown in the token list. Already filled with Codacy.Codacy
    Account API tokenThe account API token

  6. Click Test connection.

  7. Click Add. The form warns: The instance will restart after confirmation. Wait a few seconds.

The token is in the list. This step was not checked on a live instance with a working token.

The optional setting​

Under Optional settings, API address (self-hosted Codacy only) is the full address of your own Codacy, with https://. Leave it empty to use app.codacy.com.

✅ That's it!

Next: Show Codacy on a component.