@qualcomm-ui/changesets-cli
v1.0.2
Published
Changeset automation CLI for conventional commits
Readme
@qualcomm-ui/changesets-cli
Changeset automation CLI for conventional commits.
This package streamlines the release process for monorepos by converting conventional commits into changesets, managing versioning, formatting changelogs, and generating combined release notes.
Installation
pnpm add -D @qualcomm-ui/changesets-cliCommands
prep-release
Runs the full release-prep pipeline sequentially:
- Generate changesets from conventional commits
- Bump versions and generate changelogs
- Consolidate changelog formatting
- Generate combined release notes and write to a temporary file
qui-changesets prep-release [options]| Option | Description | Default |
| ----------------------------- | ----------------------------------------------------------------------------------- | ------------------------ |
| --in-steps | Pause after each step and wait for confirmation | false |
| --commit-sha <sha> | Diff each package against the target commit instead of the repository's base branch | |
| --include-commit-links | Embed commit hashes in changeset summaries for changelog links | false |
| --package-manager <command> | Package manager command to use for changeset version | pnpm |
| --config <path> | Path to the changesets config file, relative to the project root | .changeset/config.json |
changeset-generate
Generates changesets from conventional commits without running the full pipeline.
qui-changesets changeset-generate [options]| Option | Description | Default |
| ------------------------ | ----------------------------------------------------------------------------------- | ------------------------ |
| --commit-sha | Diff each package against the target commit instead of the repository's base branch | false |
| --include-commit-links | Embed commit hashes in changeset summaries for changelog links | false |
| --config <path> | Path to the changesets config file, relative to the project root | .changeset/config.json |
consolidate-changelogs
Normalizes and reformats all changed CHANGELOG.md files into a consistent structure.
qui-changesets consolidate-changelogsgenerate-release-notes
Generates combined release notes from changed package changelogs, separating substantive changes from dependency-only updates.
qui-changesets generate-release-notescheck-versions
Checks which packages have newer local versions than what is published on npm. Sets a should-publish GitHub Actions output.
qui-changesets check-versions [options]| Option | Description | Default |
| ----------------- | ---------------------------------------------------------------- | ------------------------ |
| --config <path> | Path to the changesets config file, relative to the project root | .changeset/config.json |
create-github-releases
Creates GitHub releases for published packages by parsing their changelogs.
qui-changesets create-github-releases [options]| Option | Description | Default |
| --------------------- | ---------------------------------------------------------------------------------- | ------------------------ |
| --token <token> | GitHub token for authentication (falls back to TOKEN or GITHUB_TOKEN env vars) | |
| --repo <owner/repo> | GitHub repository in owner/repo format | Derived from git remote |
| --config <path> | Path to the changesets config file, relative to the project root | .changeset/config.json |
Programmatic API
The package also exports core functions for use in scripts:
import {
conventionalCommitChangeset,
consolidateChangelogs,
generateReleaseNotes,
} from "@qualcomm-ui/changesets-cli"License
Licensed under the BSD-3-Clause-Clear License.
