Skip to content

Commit a3c8b84

Browse files
improved doc regarding branch protection rules on github (#2359)
1 parent 7b82694 commit a3c8b84

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ 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+
!!! important
67+
GitHub offers two distinct methods for implementing branch protection: utilizing the dedicated 'Branch Protection Rules' section within the 'Branches' tab, or alternatively, employing 'RuleSets' found under the 'Rules' tab. Currently, our processes are configured to primarily use the 'Branch Protection Rules' method.
68+
6669
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:
6770

6871
- **Protected**: All configured gates are required status checks in your Git provider.

0 commit comments

Comments
 (0)