Skip to content

commandGit and releases

Release Notes

Writes user-facing release notes from merged pull requests since the last release, grouped by what users can now do.

npx workspacetemplates add release-notes --tool claude-code

Writes 1 file to .claude/commands/

.claude/commands/release-notes.md14 lines · 1.1 KBFile
---
description: Writes user-facing release notes from merged pull requests since the last release, grouped by what users can now do.
argument-hint: "[since tag or date, optional]"
---

Write release notes for the changes since: $ARGUMENTS (the latest tag if empty).

1. Collect merged changes with `git log <since>..HEAD --merges --oneline`; if the project squashes, use `git log --no-merges`. When `gh` is available, read the pull request titles and descriptions for context.
2. Drop internal work: refactors, tests, CI, dependency bumps without user effect.
3. Write for the people who use the product, not the people who build it. Lead each item with the benefit ("You can now export reports as CSV"), then one clause of detail.
4. Put anything that needs action first under **Before you upgrade**: breaking changes, migrations, renamed settings, removed features, with the exact step to take.
5. Then use the sections **New**, **Improved**, **Fixed**. Credit external contributors by handle if the history shows them.

Keep it under 300 words and avoid jargon and internal ticket numbers. Show the draft, ask what to change, and do not publish or tag anything.

What it does

Release notes fail when they repeat commit messages. This command collects the merged changes and rewrites them around what people can do now, what got better and what they must change on their side.

Internal work is left out. Anything that needs action, such as a migration, a renamed setting or a removed option, is placed at the top where nobody can miss it.

Example

you › /release-notes v3.1.0

agent › Before you upgrade: the API_TOKEN setting is now called ACCESS_TOKEN. Rename it in your .env file.

New: Export any report as CSV.
Improved: Dashboards load about twice as fast on large accounts.
Fixed: Invitation emails no longer land twice in the inbox.

Questions

How is this different from the changelog entry?
A changelog is a precise record for developers. These notes are written as an announcement for the people who use the product.
Does it publish anything?
No. It prints a draft and waits for your edits.
  • Branch Cleanup

    CommandGit and releases

    Free
  • Changelog Entry

    CommandGit and releases

    Free
  • Cherry Pick Fix

    CommandGit and releases

    Free
  • Commit Message

    CommandGit and releases

    Free