-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
clean: Create a dedicated section for the service account procedure DOCS-680 #2103
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5ebed02
clean: Create a dedicated section for the service account procedure
claudiacarpinteiro 14e0e30
wip: Isolate procedure on a separate page for testing purpose
claudiacarpinteiro 9e85064
clean: Tweak title
claudiacarpinteiro 8eb6686
Merge branch 'master' into DOCS-680-dedicated-service-account
nicklem File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,2 @@ | ||
| !!! tip | ||
| Use a dedicated service account to integrate Codacy with your repositories. This prevents disruption of service if the user who originally enabled the integration loses access to the repositories, which may happen when a user leaves the team or the organization. | ||
|
|
||
| For more information and instructions on how to set up a dedicated service account see [Why did Codacy stop commenting on pull requests?](../../faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md#outdated-permissions) | ||
| Use a [dedicated service account](../../faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md#service-account) to integrate Codacy with your repositories. This prevents disruption of service if the user who originally enabled the integration loses access to the repositories, which may happen when a user leaves the team or the organization. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
docs/repositories-configure/integrations/using-a-dedicated-service-account.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # 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](https://avatars.githubusercontent.com/u/1834093) as the account picture so that your pull request comments look like the following example: | ||
|
|
||
|  | ||
|
|
||
| 1. Log out of both your Git provider and of Codacy. | ||
|
|
||
| 1. Log in to Codacy using the new service account. | ||
|
|
||
| 1. Open your repository **Settings**, tab **Integrations**, and click the link **Refresh connection** to refresh the existing Git provider integration: | ||
|
|
||
|  | ||
|
|
||
| 1. Make sure the Git provider integration is configured as needed: | ||
|
|
||
| - [Configuring the GitLab integration](gitlab-integration.md#configuring) | ||
|
|
||
| - [Configuring the Bitbucket integration](bitbucket-integration.md#configuring) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nicklem This is the option of isolating the service account procedure on a dedicated section within the same troubleshooting page.
However, I decided to try out a second option - isolating the procedure on a dedicated page. 🤓
The page title is a bit long, but it might work... Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of the separate page, but for completeness, I'd also add one sentence to explain the concept of "service account" (e.g., I like this explanation). I didn't even know it had a name 😅