Skip to content

Commit

Permalink
feat: Update GitLab option names and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Cláudia Carpinteiro committed Apr 29, 2024
1 parent 810e6de commit 3edb943
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/repositories-configure/integrations/gitlab-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The GitLab integration incorporates Codacy on your existing Git provider workflo

When you add a new repository, Codacy sets the GitLab integration using the [default settings for your organization](../../organizations/integrations/default-git-provider-integration-settings.md). You can then [customize the settings](#configuring) for the repository.

![GitLab integration](images/gitlab-integration.png)<!--TODO CY-6642 Update screenshot-->
![GitLab integration](images/gitlab-integration.png)

!!! important
Codacy uses the GitLab user who added the repository to create comments on merge requests. If that user loses access to the repository, a repository admin must [refresh the GitLab integration](#refreshing).
Expand All @@ -25,20 +25,26 @@ Depending on the options that you enable, Codacy will automatically update merge
end="<!--default-settings-apply-all-end-->"
%}

### Pull Request Status
### Status checks

Adds a report to your merge requests showing whether your merge requests and coverage are up to standards or not as configured on the [quality gate rules](../../repositories-configure/adjusting-quality-gates.md) for your project. You can then optionally [block merging merge requests that aren't up to standards](../../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests).

{% include-markdown "../../assets/includes/status-checks-important.md" %}

![Merge request status on GitLab](images/gitlab-integration-pr-status.png)

### Pull Request Comment
### Issue annotations

Adds comments on the lines of the merge request where Codacy finds new issues. Click on the links to open Codacy and see more details about the issues and how to fix them.
Adds comments on the lines of the merge request where Codacy finds new issues. Click on the links to open Codacy and see more details about the issues and how to fix them. To enable this option, you must enable **Status checks** first.

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

### Issue summaries

Shows an overall view of the changes in the merge request, including new issues and metrics such as complexity and duplication. To enable this option, you must enable **Status checks** first.

![Merge request summary on GitLab](images/gitlab-integration-pr-summary.png)

### AI-Enhanced Comments

Adds AI-enhanced comments with insights to help you fix identified issues.
Expand All @@ -47,12 +53,6 @@ Adds AI-enhanced comments with insights to help you fix identified issues.

![AI-enhanced comment on GitLab](images/gitlab-integration-ai-comment.png)

### Pull Request Summary

Shows an overall view of the changes in the merge request, including new issues and metrics such as complexity and duplication.

![Merge request summary on GitLab](images/gitlab-integration-pr-summary.png)

## Refreshing the GitLab integration {: id="refreshing"}

If the user who added the repository to Codacy loses access to the repository, which may happen when the user leaves the team or the organization, Codacy won't be able to create comments on merge requests.
Expand All @@ -65,9 +65,9 @@ In this situation, another user with [administrator access to the repository](..

1. On the GitLab integration area, click the link **Refresh connection**.

![Refresh GitLab integration](images/gitlab-integration-refresh.png)<!--TODO CY-6642 Update screenshot-->
![Refresh GitLab integration](images/gitlab-integration-refresh.png)

After refreshing the integration, Codacy will use the logged in GitLab user to create comments on merge requests.
After refreshing the integration, Codacy will use the logged in GitLab user to create comments on new merge requests.

## See also

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3edb943

Please sign in to comment.