For the latest updates and improvements, see the latest Cloud documentation instead.
How do I set Codacy as a required check to merge my PRs?¶
Codacy will check each of your Pull Requests using your quality settings, sending a notification to the Git provider informing if the PR is up to standards or not.
Each of the Git providers have different options regarding what can be done with this notification that you can set up to make sure you get a notification if the PR fails Codacy checks or block it from being merged.
GitHub¶
GitHub allows for a specific check to be mandatory for a PR to be merged. This allows our users to make sure that a PR is only merged when it gets an OK from Codacy.
Bitbucket¶
Bitbucket does not allow for a specific check to be required before merge, but instead, for a minimum number of checks to be performed successfully before the PR can be merged. This number can be zero, all the checks being run in the PR or a number in between. Some of these options are only available for certain pricing plans in Bitbucket.
GitLab¶
GitLab allows flagging merge requests as "Work In Progress" to block the merge requests from being merged.
Share your feedback 📢
Did this page help you?
Thanks for the feedback! Is there anything else you'd like to tell us about this page?
255 characters left
We're sorry to hear that. Please let us know what we can improve:
255 characters left
Alternatively, you can create a more detailed issue on our GitHub repository.
Thanks for helping improve the Codacy documentation.
If you have a question or need help please contact support@codacy.com.