ci: docs-check — require doc updates for feat PRs that change the CLI surface - #217
Merged
Conversation
…e CLI surface New `docs-check.yml` workflow: on a PR that changes the command/check surface (src/cli.ts, src/commands/**, src/checks/**, the .parityrc parser) without touching docs/**, a `feat` PR is BLOCKED and a `fix` PR gets a warning. Bypass by ticking "Docs not needed" in the PR body or adding the `skip-docs` label. Uses the conventional-commit PR title for the feat/fix distinction, mirrors ci.yml's base-ref diff (fetch-depth 0), and re-runs on edit/label so a bypass takes effect. Adds a PR template with the docs checkbox. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
Keeps docs in sync with the CLI/check surface.
docs-check.yml— on a PR that changes the command/check surface (src/cli.ts,src/commands/**,src/checks/**, the.parityrcparser) without touchingdocs/**:featPR → blocked (fail the check).fixPR → warning (non-blocking).skip-docslabel. Re-runs on edit/label so the bypass takes effect immediately.Uses the conventional-commit PR title for the feat/fix distinction; mirrors
ci.yml's base-ref diff (fetch-depth: 0). Logic simulated locally across all cases (feat/fix/docs/checkbox/label/no-surface).Also adds
.github/PULL_REQUEST_TEMPLATE.mdwith the docs checkbox, and askip-docslabel.docs/**and the Parity section on deco-sites/docs)🤖 Generated with Claude Code
Summary by cubic
Enforces docs updates when a PR changes the CLI/check surface. Previously unguarded; now
featPRs that change the surface without docs fail CI, andfixPRs get a warning.src/cli.ts,src/commands/**,src/checks/**, and the.parityrcparser atsrc/ignore/parser.ts.docs/**(and the Parity section ondeco-sites/docs) when the surface changes.skip-docslabel. The check re-runs on edit/label.featvsfixfrom the conventional-commit PR title; diffs against the base withfetch-depth: 0..github/PULL_REQUEST_TEMPLATE.mdwith a docs checkbox. CI-only; no runtime changes.Written for commit 0cd901d. Summary will update on new commits.