step-security/Changesets

A GitHub action to automate releases with Changesets

Trust Signals

name	description	required	default
github-token	The GitHub token to use for authentication. Defaults to the GitHub-provided token.	no	${{ github.token }}
publish	The command to use to build and publish packages	no	—
version	The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided	no	—
cwd	Sets the cwd for the node process. Default to `process.cwd()`	no	—
commit	The commit message. Default to `Version Packages`	no	—
title	The pull request title. Default to `Version Packages`	no	—
setupGitUser	Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`	no	true
createGithubReleases	A boolean value to indicate whether to create Github releases after `publish` or not	no	true
commitMode	An 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.	no	git-cli
branch	Sets the branch in which the action will run. Default to `github.ref_name` if not provided	no	—
prDraft	Controls 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	—

name	description
published	A boolean value to indicate whether a publishing is happened or not
publishedPackages	A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
hasChangesets	A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
pullRequestNumber	The pull request number that was created or updated