feat(pr-ready): add doc-check step to the workflow - #56
Merged
Conversation
Every PR ships without anyone asking "does this need README / ROADMAP /
CLAUDE.md updates?" because the author forgets and there's no step in
the pipeline that forces the question. Add a `doc-check` step to the
pr-ready workflow that runs after `changelog` and before `create-pr`.
The step classifies the diff (feature / bugfix / breaking / internal /
docs-only) and walks a rule table for each candidate doc at the repo
root — README.md, ROADMAP.md, CLAUDE.md / AGENTS.md, docs/, plugin.json
and other manifests, workflows/*.yml — deciding per-file whether this
PR requires an update. CHANGELOG.md is explicitly skipped because it
is owned by the release pipeline, not individual PRs.
Mechanical edits (moving a ROADMAP bullet from Planned to Implemented,
adding a README command row, renaming a manifest entry) are applied
directly via Edit/Write and committed with `docs: update <files> for
<classification>` so they land in the PR alongside the code. Ambiguous
updates are emitted as `[!]` TODO entries in the checklist output so
the user sees exactly what still needs manual attention before
`create-pr` runs.
Also updates skills/pr-ready/SKILL.md to reflect the new 9-step
pipeline.
Verified the YAML parses and step order is
validate → necessity → lint → test → security
→ changelog → doc-check → create-pr → monitor
The user-facing prompt in pr-gate.sh enumerated the pr-ready pipeline
as "lint, test, security, DRY review, changelog, monitor" — which was
already stale (no "DRY review" step exists) and is now also missing
the new doc-check step added in this PR.
Updated to match the actual workflow order after doc-check:
lint, test, security, changelog, doc-check, monitor
Found by running this PR's own doc-check rules on itself — this is
exactly the kind of stale mechanical reference doc-check is meant to
catch automatically on future PRs.
Code review on PR #56 flagged that `doc-check` was ordered after `changelog`, so any `docs: update ...` commit the step creates would not be reflected in the changelog summary that `create-pr` uses for the PR body. Swap the order to doc-check → changelog → create-pr so the changelog always sees doc-check's commits. Also expand the doc-check rule table with a `skills/*/SKILL.md` entry the review suggested was missing. SKILL.md files are a first-class user-facing surface in this repo and were not covered by the previous rules — which meant a workflow step change could slip through without syncing the matching skill's step list. New rule: edits to a `workflows/*.yml` file require the matching `skills/<name>/SKILL.md` step list to be synced, and SKILL.md mismatches are flagged as needs-update. (This PR would have caught its own manual SKILL.md update automatically under the new rule.) Updated skills/pr-ready/SKILL.md to reflect: - new order (doc-check → changelog) - skills/*/SKILL.md in the candidate list - "Runs before changelog so ..." explanation
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
Adds a
doc-checkstep to thepr-readyworkflow, wired in betweenchangelogandcreate-pr. Closes the "does this PR need README / ROADMAP / CLAUDE.md updates?" question that currently has to be asked manually on every PR.What it does
The new step classifies the diff as one of
feature / bugfix / breaking / internal / docs-only, then walks a rule table for each candidate doc at the repo root:Mechanical edits (moving a ROADMAP bullet, adding a README command row, renaming a manifest entry) are applied directly via Edit/Write and committed with
docs: update <files> for <classification>so they land in the PR alongside the code. Ambiguous updates are flagged as[!]TODO entries in the output checklist so the user sees exactly what still needs manual attention beforecreate-prruns.Output format:
Pipeline order
Before:
After:
changelogruns first so the diff's intent is already summarized whendoc-checkmakes its classification decisions.Files
workflows/pr-ready.yml— new step (~70 lines) betweenchangelogandcreate-prskills/pr-ready/SKILL.md— updated step list and descriptionTest plan
validate → necessity → lint → test → security → changelog → doc-check → create-pr → monitorpr-readyon a real PR and confirmdoc-checkemits a usable checklist[x]apply, and an internal-refactor PR emits[ ]for all docs