Skip to content

Commit c1073aa

Browse files
authored
Add details for the levels of branch protection (#2329)
Update integrating-codacy-with-your-git-workflow.md Add details for the levels of branch protection
1 parent 1d626ed commit c1073aa

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/getting-started/integrating-codacy-with-your-git-workflow.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Make sure you enable the option **Status checks** ([GitHub](../repositories-conf
4949

5050
## 3. Blocking merging pull requests (optional) {: id="blocking-pull-requests"}
5151

52-
Once you've tested out Codacy for a while and you're happy with the level of feedback provided, you can decide to enforce the quality gates and use Codacy to block merging pull requests on your Git provider. This is the best way to protect your code from unwelcome changes and fully integrates code quality and coverage analysis into your development pipeline.
52+
Once you've tested out Codacy for a while and you're happy with the level of feedback provided, you can decide to enforce the quality gates and use Codacy to block merging pull requests on your Git provider. This is the best way to protect your code from unwelcome changes and fully integrate code quality and coverage analysis into your development pipeline.
5353

5454
!!! important
5555
To eliminate any false positives that could inadvertently block the work of your team, it's important that before activating this feature you:
@@ -63,6 +63,12 @@ Follow the instructions from your Git provider to block merging pull requests if
6363
- **GitLab:** [only allow merge requests to be merged if the pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds)
6464
- **Bitbucket:** [configure Bitbucket to prevent a merge with unresolved merge checks](https://support.atlassian.com/bitbucket-cloud/docs/suggest-or-require-checks-before-a-merge/)
6565

66+
Codacy sends three different status checks to Git providers for increased granularity and customization: **quality metrics, coverage variation, and diff coverage**. These checks help you protect your repositories by indicating whether the main branch is fully, partially, or not protected:
67+
68+
- **Protected**: All configured gates are required status checks in your Git provider.
69+
- **Partially Protected**: Some configured gates are required status checks in your Git provider.
70+
- **Not Protected**: None of the configured gates are required status checks in your Git provider.
71+
6672
## You're all set! 🎉
6773

6874
**Congratulations!** You've successfully integrated and set up your first repository.

0 commit comments

Comments
 (0)