Github Action to leverage release-it in Github repositories. Must be used with actions/checkout@v2 or above.

Usage of plugins for release-it requires them to be installed in your workspace before hand.

For a node application just do:

npm install -D release-it

See release-it/release-it for details on how release-it itself works.

For plugins, do the same! Take the super useful release-it/bumper:

npm install -D @release-it/bumper

The Github token to pass to release-it.

Defaults to ${{ github.token }}.

Adds additional options to the release-it command as a serialized Json object. For example, '{"dry-run": true}'.

Defaults to {}.

Set the Github username to use for creating/pushing updates.

Defaults to ${{ github.actor }}

Set the git user name to use when release-it commits.

Defaults to release-it bump.

Set the git email address to use when release-it commits.

Defaults to env.GITHUB_EMAIL.

Name of branch to create before pushing. If not set, or empty, does not create a branch.

Useful if target branch is secured or locked from direct pushes.

Shell command to execute if a conflict occurs.

Useful if you are commiting build artifacts such as minized code.

Branch to rebase onto.

Defaults to the branch that triggered action and will not rebase onto itself.

Serialized Json return object from release-it.

Example:

{
  name: 'gh-action-release-it',
  changelog: undefined,
  latestVersion: '0.990.3',
  version: '0.990.4'
}

version returned from release-it

latestVersion returned from release-it

- name: Checkout
  uses: actions/[email protected]
  with:
    fetch-depth: 0

- name: release-it
  uses: TheRealWaldo/[email protected]
  with:
    json-opts: '{"dry-run": true}'