Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 1.92 KB

using-a-dedicated-service-account.md

File metadata and controls

34 lines (19 loc) · 1.92 KB
Raw

Integrate with your Git provider using a service account

!!! info "This page applies only to GitLab and Bitbucket"

Using a dedicated service account to integrate Codacy with your repositories prevents disruption of service if the user who originally enabled the integration loses access to the repositories.

To integrate Codacy with GitLab or Bitbucket using a dedicated service account, do the following:

  1. Create a service account on your Git provider exclusively dedicated to integrating Codacy with your repositories.

    !!! note The service account must:

    -   [Have administrator permissions](../../organizations/roles-and-permissions-for-organizations.md) on the repositories to integrate with Codacy
-   Not be shared by other systems to ensure that Codacy doesn't hit the API rate limits of the Git provider when using this account

    !!! tip Using a dedicated service account also has the advantage of any pull request comments made by Codacy appearing as authored by the service account instead of by a regular organization member. You can name this account "Codacy" and use this Codacy logo as the account picture so that your pull request comments look like the following example:

    ![Codacy comment on a GitLab merge request](images/gitlab-integration-pr-comment.png)

  2. Log out of both your Git provider and of Codacy.

  3. Log in to Codacy using the new service account.

  4. Open your repository Settings, tab Integrations, and click the link Refresh connection to refresh the existing Git provider integration:

    Refresh Git provider integration

  5. Make sure the Git provider integration is configured as needed: