Files
actions/docs/examples/azure/gitversion/setup/usage-examples.md
Chris Davis a33003e772 Improve GitVersion examples
Improved the GitVersion examples by using headings for the examples (with links) and fixing a couple of typos.
2020-11-23 11:04:19 +01:00

62 lines
1.2 KiB
Markdown

# Setup GitVersion Task (gitversion/setup) Usage Examples
Find out how to use the **gitversion/setup** task using the examples below.
> The examples use the latest _0.x_ version of the GitVersion Setup task. It is recommended to use the latest released version in your own pipelines.
## Inputs
The Setup GitVersion task accepts the following inputs:
```yaml
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.
```yaml
steps:
- task: gitversion/setup@0
displayName: Install GitVersion
inputs:
versionSpec: '5.x'
```
### Example 2
Install GitVersion 5.5.0.
```yaml
steps:
- task: gitversion/setup@0
displayName: Install GitVersion
inputs:
versionSpec: '5.5.0'
```
### Example 3
Install the latest GitVersion 6 pre-release version. For example **6.0.0-beta1.1**.
```yaml
steps:
- task: gitversion/setup@0
displayName: Install GitVersion
inputs:
versionSpec: '6.x'
includePrerelease: true
```