cstm-changeset
v1.0.5
Published
A changeset add wrapper that prompts for structured business context
Downloads
53
Maintainers
Readme
cstm-changeset
A wrapper around the changesets CLI that adds structured business context prompts to the add command — because changelogs should tell the why, not just the what.
Why?
Changesets is a fantastic tool for managing versioning and changelogs. But out of the box, it only captures what changed. When a teammate (or future you) looks back at the changelog, questions like these often go unanswered:
- What business value did this change bring?
- Did this affect clients? How?
- Was it tested? How thoroughly?
cstm-changeset fixes that by adding a quick interactive prompt after changeset add, appending structured context directly to your changeset file.
Installation
npm install -D cstm-changesetNote: Requires Node.js 24+ and
@changesets/clias a peer dependency.
Usage
Use cstm-changeset as a drop-in replacement for changeset:
npx cstm-changeset [command] [options]Commands
| Command | Description |
| ------------------- | -------------------------------------------------------------- |
| add | Create a changeset with business context prompts (default) |
| status | Show changeset status |
| version | Apply changesets and update package versions |
| publish | Publish packages to npm |
| init | Initialize changesets in your project |
| pre <enter\|exit> | Enter or exit prerelease mode |
| tag | Create git tags for published packages |
All commands (except add) pass through directly to the underlying changeset CLI.
Options
| Option | Description |
| --------------- | ------------------- |
| -h, --help | Show help message |
| -v, --version | Show version number |
Examples
# Create a changeset with business context prompts
npx cstm-changeset
npx cstm-changeset add
# Check changeset status
npx cstm-changeset status
# Apply changesets and bump versions
npx cstm-changeset version
# Publish to npm
npx cstm-changeset publish
# Initialize changesets in a new project
npx cstm-changeset initThe Add Flow
When you run npx cstm-changeset (or npx cstm-changeset add), the CLI will:
- Run the standard
changeset addflow (package selection, bump type, summary) - Prompt you with follow-up questions about business context
- Append the answers to the newly created changeset file
Business Context Questions
- What value does this change bring to the business?
- Does this carry client impact? (if yes, describe it)
- Has this been tested? (if yes, describe how)
Example Output
Here's what gets appended to your changeset:
## Business Context
**Business value:** Improves checkout conversion by reducing page load time
**Client impact:** Yes — Clients using the legacy API will need to migrate
**Tested:** Yes — Ran load tests simulating 10k concurrent usersRequirements
- Node.js 24+
@changesets/cli2+ (peer dependency)
