Skip to content

Docs: quarantine.md, new diagnostics and the Scan Diagnostics workflow - #5

Merged
Arthurvdv merged 3 commits into
mainfrom
wp08/quarantine-docs
Oct 8, 2026
Merged

Arthurvdv merged 3 commits into
mainfrom
wp08/quarantine-docs

Conversation

@Arthurvdv

Copy link
Copy Markdown
Member

Summary

  • New docs/quarantine.md for organization maintainers: what the daily Scan Diagnostics workflow does, choosing the quarantine policy (with the exact abort message), reading its one living pull request (titles, sections with live examples, record runs, why the branch is rebuilt and must not be pushed to), adopting a quarantined rule and housekeeping, changed default severities and pinning, the catalog fields and flags and catalog/scan-state.json, running it by hand (includePrerelease, direct commit, commitOptions.createPullRequest, scan.schedule and the absent-key rule, rescanning a channel), troubleshooting.
  • docs/README.md: the planned new-rules.md row becomes the written quarantine.md row.
  • docs/ghtokenworkflow.md and docs/updating.md: one sentence each on the scan using the same secret and the same schedule mechanism.
  • Behaviour described from the WP08 live run on Arthurvdv/rulebook-e2e-scan (2026-10-08) and the engine's docs/reference/scan-mechanics.md.

Merge order: ALCops/rulebook-engine#69 first; until it merges, the link to its docs/reference/scan-mechanics.md is a 404 and the base-moved message in section 8 does not exist on main.

Decisions

WP08 (ALCops/rulebook-engine#10): D45 (one living pull request, record runs) and D46 (seeded ids are known; unadvertised, deprecated and vanished ids are catalog flags).

Review

Sonnet code-review, effort high, three rounds. Round 1: 15 findings (adoption example edited a shipped base/ file, stale endpoints after a hand edit, a closed PR returning, push failure wording, housekeeping exception, overrides never release an entry, and wording), fixed in 256d806; one engine change followed (base-moved reported plain, ALCops/rulebook-engine@e37e8d6). Round 2: 3 must-change items (the live PR #2 claim, None in an own level, PowerShell 7.4) and 8 optional, all applied in 429946c. Round 3: approve.

Relates to ALCops/rulebook-engine#10

🤖 Generated with Claude Code

Arthurvdv and others added 3 commits October 8, 2026 12:32
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…egeneration, closed PR, push failures, schedule, scan-state example); scan in ghtokenworkflow.md and updating.md

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…observed, keeping a rule off, local regeneration, published levels, column values); token rows apply to the scan

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@Arthurvdv Arthurvdv added the documentation Improvements or additions to documentation label Oct 8, 2026
@Arthurvdv
Arthurvdv merged commit f1df646 into main Oct 8, 2026
@Arthurvdv
Arthurvdv deleted the wp08/quarantine-docs branch October 8, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant