Requesting an exception
A rule that blocks a change can be bypassed only by an actor the ruleset names. A bypass is granted to a role, never to a repository, and it is used for a specific change, not as a standing setting. Bundu’s written rule is that a check is never disabled or weakened to get a change through: the cause is fixed, or the exception is escalated.
Who can bypass
Section titled “Who can bypass”| Ruleset | Who can bypass |
|---|---|
enterprise-main-protection |
Enterprise owners, for every rule. Organization admins, for the pull request rule only. |
org-wide-main-protection |
Organization admins, for every rule. |
enterprise-release-version-check |
Enterprise owners. |
enterprise-dependency-review |
Enterprise owners. |
enterprise-org-workflows |
Enterprise owners. |
enterprise-code-scanning, enterprise-semgrep, enterprise-repo-standards |
Enterprise owners. |
enterprise-release-tag-protection |
The bundu-release GitHub App only. People cannot bypass it. |
enterprise-staging-protection (blocks creating a staging branch only) |
Organization admins (pull request mode, which no longer has a rule); enterprise owners; the bundu-release GitHub App. |
merge-queue-main (repository) |
No one. No bypass actors are listed. |
Two things stand out in this table. The merge queue ruleset lists no bypass actors. Version tags can be changed only by the release app, so no person can move or delete a released version.
When an exception is appropriate
Section titled “When an exception is appropriate”An exception is for a case where the rule is right and the change cannot meet it in the time available. Examples are a security fix that must ship before a dependency with a new advisory is updated, or a required workflow that is broken for a reason outside the change. It is not for a change that is simply inconvenient.
It is not appropriate to:
- disable or weaken a check to get a change green;
- use a bypass to publish a version that the release check would refuse, when the right fix is a different version;
- use a bypass to move or delete a version tag.
How to ask
Section titled “How to ask”There is no request form yet. Until one exists, use these steps. They are the minimum the written rules require.
- Open an issue in the repository the change belongs to. Title it
Exception: <ruleset or rule name> for <change>. - State the facts in the issue: the rule being bypassed, the pull request or commit, why the change cannot meet the rule in time, the risk of not making the change, and the fix that will remove the need for the exception.
- Set an end date. An exception runs until a named date, after which the rule applies again. Record the date in the issue.
- Ask an owner who can bypass the rule from the table above. The owner decides, and performs any bypass.
- Close the loop. Record in the issue whether the bypass was used, and link the pull request. Open a follow-up for the fix, so the exception does not become permanent.
Do not put credentials, tokens or private details of an app in the issue. Describe the rule by its name.
What a bypass does not change
Section titled “What a bypass does not change”A bypass applies to one ruleset and one change. It does not turn off the ruleset, change the required checks or alter the release policy, and it does not change which version the next release gets.