The Codzee check

What the check shows

• In progress while Codzee is reviewing.
• Failed when a finding that matters is still open (you choose which, below), or when the pull request breaks a blocking review rule.
• Passed when nothing is blocking. If smaller findings are open, the check's title says they don't block.
• Neutral when a review couldn't finish. The check never fails because of a problem on our side.

Codzee also sets a codzee-app commit status with the same result.

Choose what fails the check

An admin picks this in Settings → Review. The check fails when:

• Any finding is open (Critical, Major or Minor). This is the default.
• A Critical finding is open.
• A Critical or Major finding is open.
• Never. The check is always green, and only blocking review rules can fail it.

Only findings Codzee has confirmed count. Problems that were already there before the pull request, and missing tests, never fail the check. When you push a fix or resolve a conversation, the check updates straight away.

Block merges on GitHub

A failed check is a warning until you make it required. To stop risky code from being merged:

1. In GitHub, open the repository's Settings → Branches.
2. Edit your branch protection rule (or add one for your main branch).
3. Turn on Require status checks to pass before merging and choose Codzee review.

A neutral check never blocks a merge, even when it's required.

When reviews are paused

If reviews are paused in settings, or you've used your reviewed pull requests for the month, Codzee doesn't post a check at all. If the check is required, the pull request waits until reviews start again. When the month's reviewed pull requests run out, Codzee leaves one comment on the pull request to explain why.