README.md

Validate version GitHub action

checks if version tag exists

Usage

1. Store the version you need to validate in a file (eg. .version)
2. Trigger validate-version-action and pass all required inputs
3. Read out values from the outputs

Inputs

• version_filename (default: '.version') - Path to the file with application version
• github_token - Pass the secrets.GITHUB_TOKEN variable
• fail_on_error (default: 'false') - Fail the pipeline on version validation error

Outputs

• planned_version - Version from version file
• version_file_exists - False if version file doesn't exist
• tag_hash - Commit hash if version tag exists
• can_create - True if version tag can be created
• tag_exists - True if version tag already exists
• branch_name - Working branch name

Example

echo "1.0.0" > "${REPO_ROOT}/.version"

---
name: Release

on:
  push:
    branches:
      - "*"

jobs:
  validate_new_version:
    name: Validate new version
    runs-on: ubuntu-latest
    outputs:
      planned_version: ${{ steps.validate_new_version.outputs.planned_version }}
      version_file_exists: ${{ steps.validate_new_version.outputs.version_file_exists }}
      tag_hash: ${{ steps.validate_new_version.outputs.tag_hash }}
      can_create: ${{ steps.validate_new_version.outputs.can_create }}
      tag_exists: ${{ steps.validate_new_version.outputs.tag_exists }}
      branch_name: ${{ steps.validate_new_version.outputs.branch_name }}

    steps:

      - name: Check out code
        uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - name: Validate new version
        id: validate_new_version
        uses: reinvented-stuff/[email protected]
        with:
          version_filename: ".version"
          github_token: "${{secrets.GITHUB_TOKEN}}"
          fail_on_error: true
...