Graphide review
Merging and required checks
Graphide review never holds a merge on its own. What its check says, when it can go red, and how to make it a required check.
Graphide review is information. A pull request merges whether or not the review has finished, or Graphide is up at all. Pass or fail belongs to your CI.
The Graphide review check
Each review adds one Graphide review check to the pull request, with the review’s verdict and a link to the full review.
| Verdict | The check |
|---|---|
| Merge | Success |
| Look first | Neutral |
| Not reviewed | Neutral |
| Hold | Neutral, unless the repository lets the review block |
A Merge over a test the change broke shows neutral, not success: the tests did not pass, so the check does not claim they did.
A review that could not finish says so in a neutral check, Graphide review
did not finish, with the reason. Comment @graphide-review on the pull
request to try that push again.
Letting the review block
By default the check is never red. A repository can let its review block: then a Hold, or a broken rule marked as blocking, fails the check. To turn that on for a repository, email us at hello@graphide.com.
Making it a required check
Even a red check holds a merge only if you make it a required check, in the repository’s own branch settings on GitHub: add Graphide review to the status checks that must pass before merging. That is your choice, made on GitHub, and you can take it back there.
Something wrong or missing? Tell us on Discord or at hello@graphide.com.