README.md

check-version-format-action

Check and extract version string from tag.

You can know:

• Is the tagged version format correct
• Is the tagged version stable

You can get:

• Full version string (e.g. v2.3.4-beta5)
• Major version string (e.g. v2)
• Major version + pre-release string (e.g. v2-beta5)

CAUTION: v3 or later, verify version number so strictly using semver. If you want to use non-strict version number (e.g. v1.2), use v2 or earlier.

Inputs

prefix

Version prefix in tag.

e.g. v

Outputs

is_valid

Set true if found valid semver format in tag.

e.g. v1.0.0, v2.3.4-beta5 is true.

is_stable

Set true if found stable version in tag. (not have pre-release metadata and major > 0)

e.g. v1.0.0, v2.3.4, 5.6.7+build8 is true. v2.0.0-beta, v0.3.0 is false.

full

Set full version as a string (include prefix).

e.g. v1.0.0, v2.3.4-beta5

full_without_prefix

Set full version as a string (exclude prefix).

e.g. 1.0.0, 2.3.4-beta5

major

Set major version as a string (include prefix).

e.g. v1, v2

major_without_prefix

Set major version as a string (exclude prefix).

e.g. 1, 2

minor

Set minor version as a string.

e.g. 0, 3

patch

Set patch version as a string.

e.g. 0, 4

prerelease

Set pre-release version as a string.

e.g. ``, beta5

major_prerelease

Set major version with pre-release as a string (include prefix).

e.g. v1, v2-beta5

major_prerelease_without_prefix

Set major version with pre-release as a string (exclude prefix).

e.g. 1, 2-beta5

Example usage

on:
  push:
    tags:
      - 'v*'

jobs:
  test-tag:
    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
      - uses: nowsprinting/check-version-format-action@v3
        id: version
        with:
          prefix: 'v'

      - name: Version tag only step
        run: |
          echo "Found valid version format in tag!"
          echo "Full version: ${{ steps.version.outputs.full }}"
          echo "Major version: ${{ steps.version.outputs.major }}"
          echo "Major with pre-release: ${{ steps.version.outputs.major_prerelease }}"
        if: steps.version.outputs.is_valid == 'true'

      - name: Stable version only step
        run: |
          echo "Found stable version in tag!"
        if: steps.version.outputs.is_stable == 'true'

License

MIT License

How to contribute

Open an issue or create a pull request.

Start developing

npm install

Run tests

npm run test

Package (must run before checked-in)

npm run all
git add dist/
git commit -m"Update dist"

Create pull request

Be grateful if you could label the PR as enhancement, bug, chore and documentation. See PR Labeler settings for automatically labeling from the branch name.

Release workflow

Run Actions | Create release pull request | Run workflow and merge created PR. (Or bump version in package.json on default branch)

Then, Will do the release process automatically by Release workflow.

Enable Publish this Action to the GitHub Marketplace on edit release page, are publish to GitHub Marketplace. (Need manual operation)

Do NOT manually operation the following operations:

• Create release tag
• Publish draft releases