Skip to content

chore(workflows): drop CHANGELOG.md from maintainer-review docs-impact scope#1724

Merged
Wirasm merged 1 commit into
devfrom
chore/drop-changelog-from-docs-impact
May 19, 2026
Merged

chore(workflows): drop CHANGELOG.md from maintainer-review docs-impact scope#1724
Wirasm merged 1 commit into
devfrom
chore/drop-changelog-from-docs-impact

Conversation

@Wirasm
Copy link
Copy Markdown
Collaborator

@Wirasm Wirasm commented May 19, 2026

Summary

  • Problem: The maintainer-review-pr workflow's docs-impact reviewer has been flagging "missing CHANGELOG entry" at MEDIUM (sometimes HIGH) on essentially every PR since we started using it. This project doesn't follow per-PR CHANGELOG maintenance — the `/release` skill generates entries from squash-commit history at release time, so contributors writing per-PR entries would duplicate work and create merge conflicts.
  • Why it matters: Bogus blocker findings train both reviewers and contributors to treat HIGH/MEDIUM as noise. Removes recurring false-positive friction without losing real docs-impact coverage.
  • What changed: Removed the "Migration → CHANGELOG.md" bullet from the per-change analysis checklist; removed `CHANGELOG.md` from the "specific places to check" enumeration; removed "changelog entry" from the MEDIUM severity heading; added an explicit one-line callout that CHANGELOG.md is out of scope with the reason (release-time generation).
  • What did not change (scope boundary): All other docs-impact behavior is unchanged. Public APIs, CLI flags, env vars, config fields, user-facing behavior changes are still in scope across `packages/docs-web/` and `CLAUDE.md`. Project-local command file under `.archon/commands/`, loaded from disk on every workflow run, so the change takes effect on the next invocation.

UX Journey

Before

```
Maintainer review run on a code-only PR
─────────────────────────────────────────
docs-impact reviewer
├── public API check ......... pass
├── CLI flag check ........... pass
├── env var check ............ pass
└── CHANGELOG check .......... [X] FLAG MEDIUM "Missing CHANGELOG entry"
→ posted on PR
→ contributor confused (no CHANGELOG culture in repo)
→ maintainer ignores or skips merge waiting on a fix that wouldn't ship
```

After

```
docs-impact reviewer
├── public API check ......... pass
├── CLI flag check ........... pass
└── env var check ............ pass
→ no false-positive CHANGELOG flag
→ relevant findings stay visible against quieter background
```

Architecture Diagram

Single file edit; no architectural change. The maintainer-review-pr workflow continues to load `.archon/commands/maintainer-review-docs-impact.md` on each run; only the reviewer's checklist contents change.

From To Status Notes
maintainer-review-pr docs-impact command unchanged command loads from disk per run

Label Snapshot

  • Risk: `risk: low`
  • Size: `size: XS` (one file, 3 insertions / 3 deletions plus 1-line callout)
  • Scope: `workflows`
  • Module: `workflows:maintainer-review`

Change Metadata

  • Change type: `chore`
  • Primary scope: `workflows`

Linked Issue

  • Closes # none
  • Related # none — accumulated friction across ~30 maintainer-review runs this week.

Validation Evidence (required)

```bash
bun run cli validate workflows

Results: 36 valid, 0 with errors

```

  • Evidence provided: markdown-only edits to a project-local command file. `bun run cli validate workflows` confirms the workflow itself still loads. Command files are not type-checked or lint-gated.
  • If any command is intentionally skipped: `bun run validate` (full type-check/lint/test) is skipped because no source code changed.

Security Impact (required)

  • New permissions/capabilities? No
  • New external network calls? No
  • Secrets/tokens handling changed? No
  • File system access scope changed? No

Compatibility / Migration

  • Backward compatible? Yes. Existing CHANGELOG.md entries are untouched; the `/release` skill still generates the changelog from commits at release time.
  • Config/env changes? No
  • Database migration needed? No

Human Verification (required)

  • Verified scenarios:
  • Edge cases checked:
    • Real docs-impact findings (missing public-API page, stale env var docs) are still produced by other paragraphs in the command — only the CHANGELOG line is suppressed.
  • What was not verified:
    • Did not re-run maintainer-review-pr on a PR that legitimately does change `CHANGELOG.md` to confirm those edits don't accidentally surface as a finding either. Acceptable risk — the reviewer enumerates surfaces, doesn't pattern-match on file paths.

Side Effects / Blast Radius (required)

  • Affected subsystems/workflows: `maintainer-review-pr` only. Other workflows (`maintainer-standup`, `marketplace-pr-review-and-merge`, etc.) do not consume this command.
  • Potential unintended effects: a future contributor who genuinely needs a CHANGELOG entry won't be reminded by the reviewer. Acceptable — CHANGELOG ownership lives with `/release` skill.
  • Guardrails/monitoring for early detection: the `/release` skill is the canonical CHANGELOG owner; any release-time gap is caught there.

Rollback Plan (required)

  • Fast rollback command/path: `git revert` the squash commit. The prior `.archon/commands/maintainer-review-docs-impact.md` is restored verbatim.
  • Feature flags or config toggles (if any): none — project workflow command file.
  • Observable failure symptoms: docs-impact reviewer goes silent on missing-CHANGELOG findings (the change's intent). No way for it to fail more loudly.

Risks and Mitigations

  • Risk: a downstream consumer of this command file (cron, external automation) assumed the CHANGELOG line was there.
    • Mitigation: this is a project-internal Archon command file with no documented external consumers. The standup brief and `/release` skill don't import it.

Summary by CodeRabbit

  • Documentation
    • Updated documentation review workflow to clarify scope and assessment criteria for documentation impact reviews.

Review Change Stack

…t scope

The maintainer-review-pr workflow's docs-impact reviewer has been flagging
"missing CHANGELOG entry" at MEDIUM (and HIGH) on multiple PRs since we
started using it. The project doesn't follow per-PR CHANGELOG maintenance —
the `/release` skill generates entries from squash-commit history when
cutting a release, so contributors writing per-PR entries would create
duplicate work and merge conflicts.

Removes:
- the "Migration → CHANGELOG.md" bullet from the per-change analysis list
- `CHANGELOG.md` from the "specific places to check" enumeration
- "changelog entry" from the MEDIUM severity bucket heading

Adds an explicit callout that CHANGELOG.md is out of scope for this
review, with a one-line explanation of where it gets generated. Keeps the
rest of docs-impact behavior unchanged — public APIs, CLI flags, env vars,
and user-facing behavior changes are still in scope across the docs site
and CLAUDE.md.

Project-local command file (`.archon/commands/`), loaded from disk per
run, so the change takes effect on the next maintainer-review-pr
invocation.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4a9cadcb-917e-4892-9a6a-8d461754409e

📥 Commits

Reviewing files that changed from the base of the PR and between 70c9e67 and fa1665f.

📒 Files selected for processing (1)
  • .archon/commands/maintainer-review-docs-impact.md

📝 Walkthrough

Walkthrough

A maintainer docs-impact review workflow template was updated to exclude CHANGELOG.md from the review checklist and explicitly mark it out of scope. The findings template MEDIUM severity category was correspondingly adjusted to focus on documentation gaps like missing examples and cross-links.

Changes

Docs-Impact Review Workflow Update

Layer / File(s) Summary
Remove CHANGELOG.md from review scope
.archon/commands/maintainer-review-docs-impact.md
The "Specific places to check" section was updated to drop CHANGELOG.md and explicitly state it is out of scope for this review. The MEDIUM severity findings description was narrowed to focus on examples and cross-link gaps instead of changelog entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • coleam00/Archon#1430: Introduced the maintainer docs-impact review workflow specification that this PR now refines by removing CHANGELOG.md scope.
  • coleam00/Archon#1130: Consolidated Claude guidance into CLAUDE.md, which aligns with this PR's preservation of CLAUDE.md as a conditional check in the docs-impact workflow.

Poem

🐰 The changelog rests, out of view,
While CLAUDE guides what agents do,
Docs shine bright with links that bind,
Examples clear for all to find. ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/drop-changelog-from-docs-impact

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.

@Wirasm Wirasm merged commit 0adec22 into dev May 19, 2026
3 of 4 checks passed
@Wirasm Wirasm deleted the chore/drop-changelog-from-docs-impact branch May 19, 2026 11:46
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