@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-cli

Commands

prep-release

Runs the full release-prep pipeline sequentially:

1. Generate changesets from conventional commits
2. Bump versions and generate changelogs
3. Consolidate changelog formatting
4. 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-changelogs

generate-release-notes

Generates combined release notes from changed package changelogs, separating substantive changes from dependency-only updates.

qui-changesets generate-release-notes

check-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 |

check-jsdoc-since-tags

Checks for unresolved JSDoc @since next-release tags without modifying files. With no directories, it scans package source directories. Pass one or more directories to scan those trees directly. Output includes the file and the declaration that owns the tag.

qui-changesets check-jsdoc-since-tags [directories...]

update-jsdoc-since-tags

Replaces JSDoc @since next-release tags. With no directories, it updates package source directories whose current package.json version differs from the Changesets base branch. Pass --diff-ref to compare against another Git ref such as a commit SHA, tag, local branch, or remote-tracking branch like origin/main. Pass one or more directories to update those trees directly. Pass --version to use an explicit version; otherwise each custom directory must be inside a package with a current version.

qui-changesets update-jsdoc-since-tags [directories...] [--diff-ref <git-ref>] [--version <version>]

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.