action.yml

name: Changesets
description: A GitHub action to automate releases with Changesets
runs:
  using: "node24"
  main: "dist/index.js"
inputs:
  github-token:
    description: "The GitHub token to use for authentication. Defaults to the GitHub-provided token."
    required: false
    default: ${{ github.token }}
  publish-script:
    description: "The command to use to build and publish packages"
    required: false
  version-script:
    description: "The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided"
    required: false
  commit-message:
    description: "The commit message. Default to `Version Packages`"
    required: false
    default: "Version Packages"
  pr-title:
    description: "The pull request title. Default to `Version Packages`"
    required: false
    default: "Version Packages"
  pr-draft:
    description: "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."
    required: false
  pr-base-branch:
    description: "Sets the base branch of the PR. Defaults to `github.ref_name`."
    required: false
  create-github-releases:
    description: "Whether to create Github releases after publish"
    required: false
    default: true
  push-git-tags:
    description: >
      Whether to create git tags after publish. If `create-github-releases` is set to `true`,
      this option will also always be `true`.
    required: false
    default: true
  commit-mode:
    description: >
      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.
    required: false
    default: "git-cli"
  setup-git-user:
    description: Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
    required: false
    default: true
outputs:
  published:
    description: A boolean value to indicate whether a publishing is happened or not
  published-packages:
    description: >
      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"}]`
  has-changesets:
    description: A boolean about whether there were changesets. Useful if you want to create your own publishing functionality.
  pr-number:
    description: The pull request number that was created or updated
branding:
  icon: "package"
  color: "blue"