Skip to content

improved doc regarding branch protection rules on github #2359

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 7, 2025
Merged

improved doc regarding branch protection rules on github #2359

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b64a4dd
improved doc regarding branch protection rules on github
DMarinhoCodacy Mar 7, 2025
5d174e1
Merge branch 'master' into improve-branch-protection-rules-doc
DMarinhoCodacy Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/getting-started/integrating-codacy-with-your-git-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ Follow the instructions from your Git provider to block merging pull requests if
- **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)
- **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/)

!!! important
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.

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:

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