Repository navigation
Docs: changing-a-rule.md, overrides.md and the Change Rule workflow (WP09) - #6
Merged
Merged
Conversation
The engine's WP09 (ALCops/rulebook-engine#11) ships the Change Rule workflow. changing-a-rule.md describes it as observed in the live run: the form, the pull request with its before and after table and provenance, the no-op and remove-miss answers, pull request or direct commit per commitOptions.createPullRequest, the secret, custom levels in the form after an update, and troubleshooting, with two screenshots. overrides.md describes the file: entries, selectors, which entry wins, precedence and editing by hand. updating.md replaces the Validate.yaml edit with update.check (ALCops/rulebook-engine#67) and states the choice-list rewrite as live; quarantine.md, al-project.md, ghtokenworkflow.md, the index and README.md point at the workflow. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Review round 1 of the WP09 docs. A change is written when it alters an entry even if no endpoint changes (justification, a masked action, removed duplicates, a remove); nothing is written only when the entry would stay as it is or a new entry would change no endpoint (D48). A level selector reaches only that level, never levels based on it. The precedence list folds quarantine into the level result before the stage file (D41). Also: the action has no default and opens on Error with * / * preselected, a justification for a change that writes nothing is not stored, the "duplicate entries removed" note, stale endpoints regenerated in the same pull request, the notice versus the commit message of a direct commit, comments dropped on the next write, the settings-step failures, and checkForUpdates on the Validate step as a temporary edit only. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Review round 2 of the WP09 docs: the sentence read as if the endpoints showed the requested action while a more specific entry hid it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This was referenced Oct 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/changing-a-rule.md: the Change Rule workflow of the engine's WP09 as observed in the live run on a scratch repository. What it does, the form field by field (*, one level and one stage per run,Remove, the optional justification and that an empty one keeps the existing text), reading the pull request (the before and after table per endpoint with the provenance tokens,unchanged,justification updated, "now unlisted ... equals the analyzer default"), when nothing is written (the no-op notices, the remove miss), pull request or direct commit percommitOptions.createPullRequestwith the fallback, the secret, your own levels and stages in the form after an update, and a troubleshooting table. Two screenshots from the live run (docs/images/change-rule-form.png,change-rule-pr.png).docs/overrides.md: the file and its keys, selectors (slugs or*, arrays only), which entry wins (specificity, then the later entry), precedence over twins, stage, level chain, quarantine and default, an override at the analyzer default unlists the id, editing by hand (regenerate, layout, C10).docs/updating.md:update.checkin the settings replaces theValidate.yamledit for turning the update check off (Settings key to turn the Validate template update check off rulebook-engine#67); the choice-list rewrite of the Change Rule form is live, with the observed House example.docs/quarantine.md,docs/al-project.md,docs/ghtokenworkflow.md,docs/README.md(both pages written) andREADME.mdpoint at the workflow instead of "planned".Merge order: after the engine pull request ALCops/rulebook-engine#76 (WP09). These pages link the engine's
docs/reference/change-mechanics.mdand ADR D47 onmain, which exist only once #76 is merged;update.checkis onmainalready (#74).Closes nothing in this repository (issues are disabled); it completes the documentation of ALCops/rulebook-engine#11.
Review: two Sonnet rounds (round 1 with the code-review skill, round 2 manual), no must-fix left.
🤖 Generated with Claude Code