Generate a change file for the current branch's modifications using the repo's beachball setup.
Steps
-
Determine the change type:
patch— bug fixes, internal refactors, test-only changesminor— new features, new exports, new component variantsnone— changes that don't affect the published package (stories, docs, tests only)- Never use
majorwithout explicit user approval
-
Generate a descriptive message following the format:
fix(package-name): descriptionorfeat(package-name): description -
Run the repo's change script to create the change file:
yarn change
This runs beachball change --no-commit (configured in root package.json).
Beachball automatically detects which packages need change files.
For non-interactive usage with a specific type and message:
yarn beachball change --no-commit --type <type> --message "<message>"
-
Verify the change file was created:
yarn check:change
Rules
- Always use
yarn changeoryarn beachball change— never manually create change files - The message should describe the user-facing impact, not the implementation detail