Skip to content

SOLIDSoftworks/semver-tags

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

semver-tags

This action is designed to be used with CI/CD pipelines that automatically increment the version of the application.

Inputs

GITHUB_TOKEN required

The github token.

tag-prefix

A value prefixed to the version number when tagging the repo.

Default value ''

default-version

The version number that will be used if no semver tag is found.

Default value '1.0.0'

incremented-value

What value should be incremented.

Allowed values 'major'|'minor'|'patch'

Default value 'patch'

create-release

A value to set whether to create a release along with the tag. If the value is a branch name, then a release is created if value equals the name of branch that triggered the workflow.

Allowed values true|false|branch_name

Default value true

prerelease

The prerelease tag that will be used in the semver version number.

metadata

The metadata tag that will be used in the semver version number.

previous-major-version

A value to use for the major version when searching for the previous version tag.

previous-minor-version

A value to use for the minor version when searching for the previous version tag.

previous-prerelease

A value to use for the prerelease value when searching for the previous version tag.

previous-metadata

A value to use for the metadata value when searching for the previous version tag.

add-minor-tag

Adds/updates a tag for the major.minor version.

Default value false

add-major-tag

Adds/updates a tag for the major version.

Default value false

dry-run

The prerelease tag that will be used in the semver version number.

Default value false

Outputs

previous-version

The previous version number.

core-version

The core version part of the semantic version.

major-version

The major version part of the semantic version.

minor-version

The minor version part of the semantic version.

patch-version

The patch version part of the semantic version.

semantic-version

The calculated version number.

Example usage

uses: SOLIDSoftworks/semver-tags@v1
with:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
  tag-prefix: 'v'
  default-version: '0.0.1'
  prerelease: 'alpha'