Skip to content

docs(process): record direct-main docs exception#340

Merged
flyingrobots merged 1 commit into
mainfrom
docs/direct-main-exception-log
May 14, 2026
Merged

docs(process): record direct-main docs exception#340
flyingrobots merged 1 commit into
mainfrom
docs/direct-main-exception-log

Conversation

@flyingrobots
Copy link
Copy Markdown
Owner

@flyingrobots flyingrobots commented May 14, 2026

Records the docs-only direct-main exception for the built-in Echo graph data model commits and pins the future rule: prefer PRs unless emergency or explicitly authorized docs-only fast path.

Summary by CodeRabbit

  • Documentation
    • Updated changelog and established documentation for an exception policy governing direct pushes to the main branch.
    • Documented procedures for authorizing, validating, and tracking exceptions to the standard pull request workflow.
    • Specified requirements for low-risk, locally validated exceptions, including validation criteria, commit tracking, scope confirmation, and provenance recording.
    • Added initial exception entry documenting a docs-only authorization.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 14, 2026

📝 Walkthrough

Walkthrough

This PR establishes a governance process for controlled exceptions to direct-main pushes and documents the first such exception. A new exception log file defines the policy and records the specific 2026-05-14 docs-only checkpoint exception with commits, changed files, and validation details. The CHANGELOG documents this exception entry.

Changes

Exception Process Governance

Layer / File(s) Summary
Exception policy and first recorded entry
docs/procedures/DIRECT-MAIN-EXCEPTION-LOG.md
Doctrine forbids direct-main pushes by default. Exception record for 2026-05-14 documents the Echo graph model checkpoint's docs-only bypass, exact commits and changed files, confirms no Rust/source/test/workflow/script/runtime code touched, includes validation output and bypassed GitHub rule message. Future rule specifies requirements for docs-only direct pushes (exception statement, relevant docs validation, exact commits and files, confirm no source/runtime changes, and governance note when applicable).
Changelog documentation
CHANGELOG.md
Unreleased "Added" entry documents the 2026-05-14 direct-main exception, references the exception log, and restates the future PR preference rule.

🎯 1 (Trivial) | ⏱️ ~3 minutes

📝 Two docs took flight,
A governance log set right,
Exceptions recorded bright,
Future PRs the stated light. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: recording a docs-only direct-main exception in the codebase.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/direct-main-exception-log

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/procedures/DIRECT-MAIN-EXCEPTION-LOG.md`:
- Around line 73-82: Update the future-rule checklist in the
DIRECT-MAIN-EXCEPTION-LOG document to require an explicit "authorization
evidence" bullet: record the identity of the approver (who authorized) and a
link or citation to where that authorization is captured
(issue/thread/comment/PR number), and make this a mandatory item alongside the
existing items (state the exception, run docs validation, record commits/changed
files, confirm no source/runtime code touched, add process note). Ensure the new
bullet is phrased consistently with the checklist tone and placed with the other
pre-push requirements so provenance is auditable.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2ed95ea6-d281-4e3b-b578-6692b989ef3f

📥 Commits

Reviewing files that changed from the base of the PR and between 512a33d and 8aaec5f.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • docs/procedures/DIRECT-MAIN-EXCEPTION-LOG.md

Comment thread docs/procedures/DIRECT-MAIN-EXCEPTION-LOG.md
@flyingrobots flyingrobots merged commit 45a8f29 into main May 14, 2026
32 checks passed
@flyingrobots flyingrobots deleted the docs/direct-main-exception-log branch May 14, 2026 15:02
@flyingrobots
Copy link
Copy Markdown
Owner Author

| Issue | Severity | Addressed by | Regression coverage | Outcome |\n| :--- | :--- | :--- | :--- | :--- |\n| Direct-main exception checklist did not require explicit authorizer identity and evidence citation. | P1 | 70794fc | markdownlint-cli2; npx markdownlint-cli2 CHANGELOG.md docs/procedures/DIRECT-MAIN-EXCEPTION-LOG.md | Resolved |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant