Skip to content

docs(version): match the README flag table to the CLI - #677

Merged
goosewobbler merged 2 commits into
mainfrom
docs/version-readme-flags
Oct 22, 2026
Merged

goosewobbler merged 2 commits into
mainfrom
docs/version-readme-flags

Conversation

@goosewobbler

@goosewobbler goosewobbler commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

Description

The @releasekit/version README's flag table had drifted from packages/version/src/command.ts:

  • Listed but not real: --strict-reachable, --verbose, --quiet — the command defines none of them.
  • Missing: -c, --config, --stable, --allow-first-bump, -s, --sync, --include-prerequisites, the short aliases (-b, -p, -t, -d, -j), and prerelease as a --bump type.

The table now lists exactly the command's options, in its order.

Split out of #616, where the review flagged the same rewrite as a second concern. #616 keeps only its own row changes (--json → envelope wording, the new --output row), so whichever of the two merges second will need a small conflict resolution in this table.

Related Issue(s)

Split from #616.

Type of Change

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation change
  • refactor — Code refactoring
  • test — Adding or updating tests
  • chore — Maintenance, dependencies, tooling
  • Breaking change — Requires major version bump

Scope

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/config
  • @releasekit/core
  • CI / workflows
  • Root / monorepo

Checklist

  • Lint passes (pnpm lint)
  • Tests pass (pnpm test) — docs only
  • Typecheck passes (pnpm typecheck) — docs only
  • Documentation updated (if applicable)
  • Breaking changes noted in description

Testing Notes

Each row checked against the .option(...) calls in packages/version/src/command.ts on main.


Generated by Claude Code

RetriggerView in GreptileConfidence Score: 5/5

This documentation change appears safe to merge.

Summary

Updates the @releasekit/version README flag table to match the CLI.

  • The version README now lists the CLI options in the order the command defines them.

Reviews (2) · Last reviewed commit: "docs(version): mention group expansion f..." · Reviewed by Greptile

The table listed --strict-reachable, --verbose and --quiet, which the
command doesn't have, and missed --config, --stable, --allow-first-bump,
--sync, --include-prerequisites, the short aliases and the prerelease
bump type.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HQN3v9Z4f1mu3xK4Z7K44e
@github-actions

github-actions Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Standing release PR: #614 · v0.42.0 queued (4 packages) · open 81d 23h 42m · ✅ ready to merge

Release Preview — v0.41.2 → v0.41.3

Note: Labels on this PR are advisory in standing-pr mode. Bumps come from conventional commits in the standing PR; override by editing labels on the standing PR itself. Add release:immediate to bypass the standing PR and release this PR directly.

These changes will be added to the release PR (#614) when merged:

Changelog

monorepo 0.41.2 → 0.41.3

Changed

  • mention group expansion for --include-prerequisites (version)
  • match the README flag table to the CLI (version)

All packages → 0.41.3 (sync versioning)

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release

After merge — predicted release

No version escalation — this PR's changes will be included in the queued release without affecting the projected versions.

Package Standing PR This PR After merge
monorepo 0.42.0 0.41.3 0.42.0

Updated automatically by ReleaseKit

Comment thread packages/version/README.md Resolved
@goosewobbler

Copy link
Copy Markdown
Owner Author

@greptileai review plz

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