Skip to content

ci: check for stale cli-generated.md#9540

Merged
hi-ogawa merged 1 commit intovitest-dev:mainfrom
hi-ogawa:ci/check-stale-cli-docs
Jan 28, 2026
Merged

ci: check for stale cli-generated.md#9540
hi-ogawa merged 1 commit intovitest-dev:mainfrom
hi-ogawa:ci/check-stale-cli-docs

Conversation

@hi-ogawa
Copy link
Copy Markdown
Collaborator

@hi-ogawa hi-ogawa commented Jan 28, 2026

Description

Add pnpm -C docs run cli-table to the lint job before the stale artifact check. This regenerates cli-generated.md during CI so the git diff --exit-code check can catch when it's out of sync with the CLI config.

The lint job already checks for stale build artifacts, but cli-generated.md was never regenerated because the docs build isn't part of the main pnpm run build. This allowed stale CLI docs to slip through PRs.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.
  • Please check Allow edits by maintainers to make review process faster. Note that this option is not available for repositories that are owned by Github organizations.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

The lint job checks for stale build artifacts with `git diff --exit-code`,
but `cli-generated.md` was never regenerated during CI because the docs
build is not part of the main build. This allowed stale CLI docs to slip
through PRs.

Add `pnpm -C docs run cli-table` before the stale check to catch this.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 28, 2026

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e3308b8
🔍 Latest deploy log https://app.netlify.com/projects/vitest-dev/deploys/6979580b5d3b790008033d0b
😎 Deploy Preview https://deploy-preview-9540--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

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

Nice! We always forget to update the auto-generated docs 🙃

@hi-ogawa hi-ogawa merged commit b19165b into vitest-dev:main Jan 28, 2026
13 of 16 checks passed
@hi-ogawa hi-ogawa deleted the ci/check-stale-cli-docs branch January 28, 2026 07:17
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.

2 participants