changesets/Changesets

A GitHub action to automate releases with Changesets

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jul 5, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: changesets/action@a45c4d594aa4e2c509dc14a9f2b3b67ba3780d0d # v1.9.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
github-tokenThe GitHub token to use for authentication. Defaults to the GitHub-provided token.no${{ github.token }}
publish-scriptThe command to use to build and publish packagesno
version-scriptThe command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not providedno
commit-messageThe commit message. Default to `Version Packages`noVersion Packages
pr-titleThe pull request title. Default to `Version Packages`noVersion Packages
pr-draftControls draft PR behavior. Use 'create' to create new version PRs as draft, or 'always' to also convert existing version PRs back to draft when updating them.no
pr-base-branchSets the base branch of the PR. Defaults to `github.ref_name`.no
create-github-releasesWhether to create Github releases after publishnotrue
push-git-tagsWhether to create git tags after publish. If `create-github-releases` is set to `true`, this option will also always be `true`. notrue
commit-modeAn enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI, or "github-api" to push changes via the GitHub API. When using "github-api", all commits and tags are signed using GitHub's GPG key and attributed to the user or app who owns the GITHUB_TOKEN. nogit-cli
setup-git-userSets up the git user for commits as `"github-actions[bot]"`. Default to `true`notrue
namedescription
publishedA boolean value to indicate whether a publishing is happened or not
published-packagesA JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
has-changesetsA boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
pr-numberThe pull request number that was created or updated