Added setup and execute task examples.

This commit is contained in:
Chris Davis
2020-11-19 22:10:23 +00:00
committed by Artur
parent b7cd8c7635
commit 9a35a04f4c
3 changed files with 361 additions and 42 deletions

View File

@@ -0,0 +1,57 @@
# Setup GitVersion Task (gitversion/setup) Usage Examples
Find out how to use the **gitversion/setup** task using the examples below.
## Task 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
```