Skip to content

📝 Fix changelog --to docs#29

Merged
sjquant merged 1 commit into
mainfrom
sjquant/fix-changelog-to-docs
May 17, 2026
Merged

📝 Fix changelog --to docs#29
sjquant merged 1 commit into
mainfrom
sjquant/fix-changelog-to-docs

Conversation

@sjquant
Copy link
Copy Markdown
Owner

@sjquant sjquant commented May 17, 2026

Why

The website documented flopha changelog --to as usable for an upcoming version before its tag exists, but the CLI requires --to to resolve to an existing tag or ref because it bounds the commit history.

Changes

  • Clarify the command reference so --to is documented as an existing upper-bound tag/ref.
  • Update release workflow examples to use --title "Changes in ..." when naming an upcoming version before tagging.
  • Keep --to examples scoped to historical ranges between existing versions.

Verification

  • cargo test test_changelog_to_nonexistent_tag_errors -- --nocapture
  • pnpm --dir website typecheck
  • pnpm --dir website build

@sjquant sjquant self-assigned this May 17, 2026
@sjquant sjquant merged commit 5f5ef48 into main May 17, 2026
4 checks passed
@sjquant sjquant deleted the sjquant/fix-changelog-to-docs branch May 17, 2026 06:36
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