Skip to content
Sign in

Reference

Enforcement statuses

Updated

On this page

Whether GitHub really blocks a merge into a branch until Zof / Control is green. You see one label per branch on the Configuration tab (Integrations, then the GitHub card). Each repository's row shows its default branch. Open the row for every branch, with a short line under the branch name that says why. The System map column is not an enforcement status. On a pull request's page in Releases, a branch that isn't enforced shows "Merge blocking is off" with the reason.

LabelDoes GitHub block a merge?What fixes it
EnforcedYes, while the check isn't greenNothing. Keep the bypass list empty.
Not enforcedNoA ruleset that requires the check from the Zof GitHub App
Needs a paid planNoA GitHub plan that allows rulesets on private repositories
Can't confirmTreated as noDepends on the line under the branch name

Zof checks the branches it gates: each repository's default branch, and the base branch of every open pull request. It checks again when a ruleset or branch protection rule in the repository changes, and about every 10 minutes. For why this matters, see Advisory and enforced.

Statuses

enforced

Label: Enforced

GitHub requires the Zof / Control check from the Zof GitHub App on this branch, through an active ruleset or classic branch protection. GitHub keeps the merge button disabled while the check isn't green.

Enforced doesn't prove that nobody can merge around Zof. Zof doesn't read the ruleset's bypass list, so check it yourself. With classic branch protection, the line under the branch name says "admins can merge around it" unless "Do not allow bypassing the above settings" is on.

What to do: Nothing. Keep the ruleset's bypass list empty. See Make Zof block merges.

not_enforced

Label: Not enforced

No active rule requires Zof / Control from the Zof GitHub App on this branch. Common causes:

  • there is no ruleset or branch protection for this branch;
  • the ruleset is Disabled, or in Evaluate mode;
  • the ruleset doesn't target this branch;
  • the rule accepts the check from any source.

The line under the branch name usually says "no rule requires Zof / Control from the Zof app". Every pull request into the branch whose check isn't green starts with "Not enforced: developers can merge this PR despite this result".

What to do: Add or fix the ruleset. See Make Zof block merges.

plan_unsupported

Label: Needs a paid plan

The repository is private, and GitHub doesn't allow rulesets on it with the current plan. Private repositories need GitHub Pro for a personal account, or GitHub Team or Enterprise for an organization. The pull request checks say "Private repositories need GitHub Pro, Team or Enterprise for rulesets."

What to do: Upgrade the GitHub plan, then add the ruleset. Until then, Zof is advisory on this repository.

unknown

Label: Can't confirm

Zof couldn't tell whether GitHub blocks merges into this branch. Zof never treats this as enforced: pull requests into the branch get the same warning as for Not enforced. Any status the console doesn't recognise also shows as Can't confirm.

The line under the branch name saysWhat it meansWhat to do
"not checked yet"Zof hasn't read this branch's rules yet.Wait up to about 10 minutes.
"last check older than 24 h"Zof's last reading is too old to rely on.Wait for the next check. If it keeps happening, email support@zofai.com.
"couldn't read" with HTTP 403 or HTTP 422The Zof GitHub App's installation is missing a permission it needs to read branch protection (Administration: read). GitHub refuses the read, and Zof keeps that refusal for an hour before it asks again. A GitHub rate limit never shows here: Zof waits and retries it.Accept the app's pending permission request in the GitHub organization's settings, or ask an org admin to. Zof checks again within about an hour.
"couldn't read GitHub's rules", or "couldn't read" with another HTTP codeGitHub was unavailable or gave an answer Zof couldn't read.Wait for the next check. If it keeps happening, email support@zofai.com.
"repo removed"The Zof GitHub App no longer has this repository, so Zof doesn't gate it.To gate it again, add the repository to the installation on GitHub.
"the branch doesn't exist yet (an empty repository has no branches)"There is nothing to protect yet.Push the first commit, then add the ruleset.

What to do: Follow the table, then check the Configuration tab again after the next check.

Next steps