Skip to content

Latest commit

 

History

History
126 lines (75 loc) · 2.57 KB

README.md

File metadata and controls

126 lines (75 loc) · 2.57 KB
Raw

release-it Github Action

Tests

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

Inputs

github-token

The Github token to pass to release-it.

Defaults to ${{ github.token }}.

no-increment

Whether release-it should increment the version or not.

Defaults to false.

debug

Whether to run release-it in debug mode or not.

Defaults to false.

json-opts

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

Defaults to {}.

github-username

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

Defaults to ${{ github.actor }}

git-user-name

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

Defaults to release-it bump.

git-user-email

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

Defaults to env.GITHUB_EMAIL.

create-branch

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.

auto-resolve-command

Shell command to execute if a conflict occurs.

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

rebase-onto

Branch to rebase onto.

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

Outputs

json-result

Serialized Json return object from release-it.

Example:

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

version

version returned from release-it

latestVersion

latestVersion returned from release-it

changelog

changelog returned from release-it

Example Usage

- name: Checkout
  uses: actions/[email protected]
  with:
    fetch-depth: 0
    # The Checkout actions at v2 and beyond prevent pushes as another user due to persist-credentials being set to true by default
    persist-credentials: false

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