actions/docs/examples/github/gitversion/setup/usage-examples.md

Setup GitVersion Action (gitversion/setup) Usage Examples

Find out how to use the gitversion/setup action using the examples below.

The examples use version 0.9.6 of the GitVersion Execute action. It is recommended to use the latest released version in your own workflows.

Inputs

The Setup GitVersion action accepts the following inputs:

versionSpec:
  description: Required version in the form of 5.x or exact version like 5.0.0.
  required: true
  default: ''
includePrerelease:
  description: Include pre-release versions when matching a version.
  required: false
  default: false

---

Usage examples

• Example 1: Install the latest GitVersion 5 version.

  steps:
    - name: Install GitVersion
      uses: gittools/actions/gitversion/setup@v0.9.6
      with:
        versionSpec: '5.x'
  

---

• Example 2: Install GitVersion 5.5.0.

  steps:
    - name: Install GitVersion
      uses: gittools/actions/gitversion/setup@v0.9.6
      with:
        versionSpec: '5.5.0'
  

---

• Example 3: Install the latest GitVersion 6 pre-release version. For example 6.0.0-beta1.1.

  steps:
    - name: Install GitVersion
      uses: gittools/actions/gitversion/setup@v0.9.6
      with:
        versionSpec: '6.x'
        includePrerelease: true