This action calculates the semantic version of the repository using the GitVersion tool, and then creates a Git tag and GitHub release. Optionally you can pass in a pre-determined semantic version and that will be used instead.

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    outputs:
      version: ${{ steps.release.outputs.version }}
      major: ${{ steps.release.outputs.major }}
      minor: ${{ steps.release.outputs.minor }}
      patch: ${{ steps.release.outputs.patch }}
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0   # required for GitVersion to read full history

      - uses: f2calv/gha-release-versioning@v1
        id: release
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Note: fetch-depth: 0 is required so GitVersion can read the full commit history to calculate the version.

A GitVersion.yml file is required in the repository root when gv-source is used. The configuration schema changed between GitVersion v5 and v6 — the main difference is that branch pre-release labels are configured with label: in v6 (previously tag: in v5).

The action auto-detects the GitVersion version from the config file: if the config contains label: keys under branches, 6.x is used; if it contains tag: keys, 5.x is used. There is no need to specify the version manually.

mode: MainLine
branches:
  main:
    regex: ^main$
    tag: ''
  feature:
    regex: ^features?[/-]
    tag: useBranchName

mode: ContinuousDeployment
branches:
  main:
    regex: ^main$
    label: ''
  feature:
    regex: ^features?[/-]
    label: useBranchName

Note: tag: in v5 branch config is a pre-release label setting and is not related to Git tags. In v6 this field was renamed to label: to avoid confusion. The mode value also changed: MainLine in v5 became ContinuousDeployment in v6 (both produce clean versions on the default branch without requiring a pre-existing tag).

MIT