dist update

Bump semver from 7.5.4 to 7.6.0

.azure/ci.yml

@@ -0,0 +1,47 @@
+trigger:
+  - main
+pr:
+  - main
+
+variables:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 'true'
+  DOTNET_CLI_TELEMETRY_OPTOUT: 'true'
+  INPUT_VERSIONSPEC: '5.x'
+
+jobs:
+- job: build
+  displayName: ''
+  strategy:
+    matrix:
+      'ubuntu-latest':
+        imageName: 'ubuntu-latest'
+      'macos-latest':
+        imageName: 'macos-latest'
+      'windows-latest':
+        imageName: 'windows-latest'
+
+  pool:
+    vmImage: $(imageName)
+
+  steps:
+    - checkout: self
+      fetchDepth: '0'
+    - pwsh: |
+        npm install
+        npm run format-check
+        npm run build:github
+        npm run build:azure
+      displayName: 'Build code'
+    - pwsh: $env:INPUT_VERSIONSPEC = "$(INPUT_VERSIONSPEC)"; node ./gitversion/setup/bundle.js
+      displayName: gitversion/setup
+      workingDirectory: dist/azure
+    - pwsh: node ./gitversion/execute/bundle.js
+      name: version
+      displayName: gitversion/execute
+      workingDirectory: dist/azure
+    - pwsh: |
+        echo "FullSemVer (fullSemVer)                    : $(fullSemVer)"
+        echo "FullSemVer (GitVersion_FullSemVer)         : $(GitVersion_FullSemVer)"
+        echo "FullSemVer (version.fullSemVer)            : $(version.fullSemVer)"
+        echo "FullSemVer (version.GitVersion_FullSemVer) : $(version.GitVersion_FullSemVer)"
+      displayName: Use variables and output

.editorconfig

@@ -8,6 +8,7 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+max_line_length = off
 
 [*.yml]
 indent_size = 2

.github/dependabot.yml

@@ -1,5 +1,13 @@
 version: 2
 updates:
+- package-ecosystem: github-actions
+  labels:
+    - "dependencies"
+  commit-message:
+    prefix: "(build deps)"
+  directory: "/"
+  schedule:
+    interval: daily
 - package-ecosystem: npm
   directory: "/"
   schedule:

.github/mergify.yml

@@ -0,0 +1,23 @@
+pull_request_rules:
+  - name: Automatic approve on dependabot PR
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      review:
+        type: APPROVE
+  - name: Automatic merge on dependabot PR after success CI
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+      - '#commits-behind=0' # Only merge up to date pull requests
+      - check-success=build (windows-latest)
+      - check-success=build (ubuntu-latest)
+      - check-success=build (macos-latest)
+    actions:
+      merge:
+  - name: Thank contributor
+    conditions:
+      - merged
+      - -author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      comment:
+        message: "Thank you @{{author}} for your contribution!"

.github/workflows/ci.yml

@@ -2,11 +2,15 @@ name: CI
 on:
   push:
     branches:
-    - master
+    - main
 
   pull_request:
     branches:
-    - master
+    - main
+
+defaults:
+  run:
+    shell: pwsh
 
 jobs:
   build:
@@ -17,22 +21,47 @@ jobs:
         os: [windows-latest, ubuntu-latest, macos-latest]
       fail-fast: false
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+      if: github.event_name == 'push'
+      with:
+        token: ${{ secrets.PUSH_GITHUB_TOKEN }}
+    - uses: actions/checkout@v4
+      if: github.event_name == 'pull_request'
     - name: Fetch all history for all tags and branches
       run: |
         git fetch --prune --unshallow
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '20'
     - run: |
         npm install
         npm run format-check
         npm run build:github
         npm run build:azure
       name: Build code
-    - name: Install GitVersion
+    - name: gitversion/setup
       uses: ./gitversion/setup
       with:
         versionSpec: '5.x'
-    - name: Use GitVersion
+    - name: gitversion/execute
       id: gitversion # step id used as reference for output values
       uses: ./gitversion/execute
     - run: |
-        echo "FullSemVer: ${{ steps.gitversion.outputs.fullSemVer }}"
+        echo "FullSemVer (env.fullSemVer)                                 : ${{ env.fullSemVer }}"
+        echo "FullSemVer (env.GitVersion_FullSemVer)                      : ${{ env.GitVersion_FullSemVer }}"
+        echo "FullSemVer (steps.gitversion.outputs.fullSemVer)            : ${{ steps.gitversion.outputs.fullSemVer }}"
+        echo "FullSemVer (steps.gitversion.outputs.GitVersion_FullSemVer) : ${{ steps.gitversion.outputs.GitVersion_FullSemVer }}"
+      name: Use variables and output
+    - name: Check for changes
+      if: matrix.os == 'ubuntu-latest' && github.event_name == 'push'
+      id: status
+      run: |
+        if ($null -ne (git status --porcelain)) { echo "has_changes=1"; echo "has_changes=1" >> $env:GITHUB_OUTPUT }
+    - name: Rebuild dist and push
+      run: |
+        git add --verbose .
+        git config user.name 'Artur Stolear'
+        git config user.email 'artur.stolear@gmail.com'
+        git commit -m 'dist update' --allow-empty
+        git push --force
+      if: steps.status.outputs.has_changes == '1'

.github/workflows/release.yml

@@ -3,6 +3,10 @@ on:
   release:
     types: [published]
 
+defaults:
+  run:
+    shell: pwsh
+
 jobs:
   build:
 
@@ -11,7 +15,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Fetch all history for all tags and branches
       run: |
         git fetch --prune --unshallow
@@ -31,17 +35,16 @@ jobs:
       id: gitversion # step id used as reference for output values
       uses: ./gitversion/execute
     - run: |
-        $date = Get-Date -format "yyMMddHHmm"
+        $date = Get-Date -format "yyMMddHH"
         $version = "${{steps.gitversion.outputs.majorMinorPatch}}.$date"
         $major = "${{steps.gitversion.outputs.major}}"
         $minor = "${{steps.gitversion.outputs.minor}}"
         $patch = "${{steps.gitversion.outputs.patch}}"
 
-        . .\dist\azure\update-version.ps1
+        . .\dist\azure\update-version.ps1 # Import the functions
         update-manifest .\dist\azure\vss-extension.json -Version $version
         dir -r .\dist\**\task.json | % { update-task $_ -Major $major -Minor $minor -Patch $patch }
 
         npm run publish:azure -- --token ${{ secrets.TFX_TOKEN }}
 
-      shell: pwsh
       name: Publish Azure extension

.gitignore

@@ -4,3 +4,6 @@ node_modules/
 *.js
 !dist/**/*.js
 *.vsix
+
+.idea/
+/dist/mock/

.prettierrc.json

@@ -1,5 +1,5 @@
 {
-    "printWidth": 80,
+    "printWidth": 160,
     "tabWidth": 4,
     "useTabs": false,
     "semi": false,

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "yaml.schemas": {
+        "file:///c%3A/Users/Artur.Stolear/.vscode/extensions/docsmsft.docs-yaml-0.2.9/out/yaml-support/toc.schema.json": "/toc\\.yml/i",
+        "https://raw.githubusercontent.com/microsoft/azure-pipelines-vscode/master/service-schema.json": "file:///d%3A/Projects/OSS/GitTools/actions/.azure/ci.yml"
+    }
+}

README.md

@@ -2,13 +2,15 @@
 
 ![GitTools](docs/icon.png "GitTools")
 
-GitHub Actions that allow to install and use the [GitVersion](https://github.com/GitTools/GitVersion) and [GitReleaseManager](https://github.com/GitTools/GitReleaseManager) tools
+GitHub Actions that allow the setup and use of the [GitVersion](https://github.com/GitTools/GitVersion) and [GitReleaseManager](https://github.com/GitTools/GitReleaseManager) tools.
 
 [![Build Status](https://github.com/GitTools/actions/workflows/CI/badge.svg)](https://github.com/GitTools/actions/actions)
 [![Build Status](https://github.com/GitTools/actions/workflows/release/badge.svg)](https://github.com/GitTools/actions/actions)
 
-[![Azure Pipeline Task](https://img.shields.io/badge/marketplace-gittools.gittools-blue?logo=visual-studio)](https://marketplace.visualstudio.com/items?itemName=gittools.gittools)
-[![Github Action](https://img.shields.io/badge/marketplace-use--actions-blue?logo=github)](https://github.com/marketplace/actions/use-actions)
+[![GitHub Release](https://img.shields.io/github/v/release/gittools/actions?logo=github&sort=semver)](https://github.com/GitTools/actions/releases/latest)
+
+[![Azure Pipelines Task](https://img.shields.io/badge/marketplace-gittools.gittools-blue?logo=azure-pipelines)](https://marketplace.visualstudio.com/items?itemName=gittools.gittools)
+[![Github Action](https://img.shields.io/badge/marketplace-gittools-blue?logo=github)](https://github.com/marketplace/actions/gittools)
 
 ## Usage
 
@@ -17,11 +19,11 @@ GitHub Actions that allow to install and use the [GitVersion](https://github.com
 Examples for usage of **GitVersion**:
 
 - [GitHub Actions](docs/examples/github/gitversion/index.md)
-- [Azure Pipeline tasks](docs/examples/azure/gitversion/index.md)
+- [Azure Pipelines tasks](docs/examples/azure/gitversion/index.md)
 
 ### GitReleaseManager
 
 Examples for usage of **GitReleaseManager**:
 
 - [GitHub Actions](docs/examples/github/gitreleasemanager/index.md)
-- [Azure Pipeline tasks](docs/examples/azure/gitreleasemanager/index.md)
+- [Azure Pipelines tasks](docs/examples/azure/gitreleasemanager/index.md)

action.yml

@@ -1,18 +1,9 @@
-name: use-actions
-description: GitHub Action for Easy Semantic Versioning with GitVersion. Installs the specific version of GitVersion.Tool
+name: GitTools
+description: Build tasks for easy semantic versioning for projects using Git and release management.
 author: GitTools
 branding:
   color: gray-dark
   icon: git-pull-request
-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
 runs:
-  using: node12
+  using: node20
   main: dist/github/setup/index.js

dist/azure/gitreleasemanager/addasset/task.json

@@ -12,56 +12,68 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/addasset",
-    "inputs": [{
-        "name": "owner",
-        "type": "string",
-        "label": "The owner of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The owner of the repository"
-    }, {
-        "name": "repository",
-        "type": "string",
-        "label": "The name of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the repository"
-    }, {
-        "name": "token",
-        "type": "string",
-        "label": "The access token to access GitHub with",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The access token to access GitHub with"
-    }, {
-        "name": "tagName",
-        "type": "string",
-        "label": "The name of the release",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the release"
-    }, {
-        "name": "assets",
-        "type": "multiLine",
-        "label": "Path(s) to the file(s) to include in the release",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "Path(s) to the file(s) to include in the release. Separated by newline"
-    }, {
-        "name": "targetDirectory",
-        "type": "string",
-        "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
-    }]
-}
+    "inputs": [
+        {
+            "name": "owner",
+            "type": "string",
+            "label": "The owner of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The owner of the repository"
+        },
+        {
+            "name": "repository",
+            "type": "string",
+            "label": "The name of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the repository"
+        },
+        {
+            "name": "token",
+            "type": "string",
+            "label": "The access token to access GitHub with",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The access token to access GitHub with"
+        },
+        {
+            "name": "tagName",
+            "type": "string",
+            "label": "The name of the release",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the release"
+        },
+        {
+            "name": "assets",
+            "type": "multiLine",
+            "label": "Path(s) to the file(s) to include in the release",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "Path(s) to the file(s) to include in the release. Separated by newline"
+        },
+        {
+            "name": "targetDirectory",
+            "type": "string",
+            "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
+        }
+    ]
+}

dist/azure/gitreleasemanager/close/task.json

@@ -12,49 +12,60 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/close",
-    "inputs": [{
-        "name": "owner",
-        "type": "string",
-        "label": "The owner of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The owner of the repository"
-    }, {
-        "name": "repository",
-        "type": "string",
-        "label": "The name of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the repository"
-    }, {
-        "name": "token",
-        "type": "string",
-        "label": "The access token to access GitHub with",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The access token to access GitHub with"
-    }, {
-        "name": "milestone",
-        "type": "string",
-        "label": "The milestone to use",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The milestone to use"
-    }, {
-        "name": "targetDirectory",
-        "type": "string",
-        "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
-    }]
-}
+    "inputs": [
+        {
+            "name": "owner",
+            "type": "string",
+            "label": "The owner of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The owner of the repository"
+        },
+        {
+            "name": "repository",
+            "type": "string",
+            "label": "The name of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the repository"
+        },
+        {
+            "name": "token",
+            "type": "string",
+            "label": "The access token to access GitHub with",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The access token to access GitHub with"
+        },
+        {
+            "name": "milestone",
+            "type": "string",
+            "label": "The milestone to use",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The milestone to use"
+        },
+        {
+            "name": "targetDirectory",
+            "type": "string",
+            "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
+        }
+    ]
+}

dist/azure/gitreleasemanager/create/task.json

@@ -12,84 +12,100 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/create",
-    "inputs": [{
-        "name": "owner",
-        "type": "string",
-        "label": "The owner of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The owner of the repository"
-    }, {
-        "name": "repository",
-        "type": "string",
-        "label": "The name of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the repository"
-    }, {
-        "name": "token",
-        "type": "string",
-        "label": "The access token to access GitHub with",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The access token to access GitHub with"
-    }, {
-        "name": "milestone",
-        "type": "string",
-        "label": "The milestone to use",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The milestone to use"
-    }, {
-        "name": "name",
-        "type": "string",
-        "label": "The name of the release",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The name of the release"
-    }, {
-        "name": "inputFilePath",
-        "type": "string",
-        "label": "The path to the file to be used as the content of the release notes",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The path to the file to be used as the content of the release notes"
-    }, {
-        "name": "isPreRelease",
-        "type": "boolean",
-        "label": "Creates the release as a pre-release",
-        "defaultValue": "false",
-        "required": false,
-        "helpMarkDown": "Creates the release as a pre-release"
-    }, {
-        "name": "targetcommitish",
-        "type": "string",
-        "label": "The commit to tag. Can be a branch or SHA. Defaults to repository's default branch",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The commit to tag. Can be a branch or SHA. Defaults to repository's default branch"
-    }, {
-        "name": "targetDirectory",
-        "type": "string",
-        "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
-    }, {
-        "name": "assets",
-        "type": "multiLine",
-        "label": "Path(s) to the file(s) to include in the release",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "Path(s) to the file(s) to include in the release. Separated by newline"
-    }]
-}
+    "inputs": [
+        {
+            "name": "owner",
+            "type": "string",
+            "label": "The owner of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The owner of the repository"
+        },
+        {
+            "name": "repository",
+            "type": "string",
+            "label": "The name of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the repository"
+        },
+        {
+            "name": "token",
+            "type": "string",
+            "label": "The access token to access GitHub with",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The access token to access GitHub with"
+        },
+        {
+            "name": "milestone",
+            "type": "string",
+            "label": "The milestone to use",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The milestone to use"
+        },
+        {
+            "name": "name",
+            "type": "string",
+            "label": "The name of the release",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The name of the release"
+        },
+        {
+            "name": "inputFilePath",
+            "type": "string",
+            "label": "The path to the file to be used as the content of the release notes",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The path to the file to be used as the content of the release notes"
+        },
+        {
+            "name": "isPreRelease",
+            "type": "boolean",
+            "label": "Creates the release as a pre-release",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Creates the release as a pre-release"
+        },
+        {
+            "name": "targetcommitish",
+            "type": "string",
+            "label": "The commit to tag. Can be a branch or SHA. Defaults to repository's default branch",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The commit to tag. Can be a branch or SHA. Defaults to repository's default branch"
+        },
+        {
+            "name": "targetDirectory",
+            "type": "string",
+            "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
+        },
+        {
+            "name": "assets",
+            "type": "multiLine",
+            "label": "Path(s) to the file(s) to include in the release",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "Path(s) to the file(s) to include in the release. Separated by newline"
+        }
+    ]
+}

dist/azure/gitreleasemanager/discard/task.json

@@ -12,49 +12,60 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/discard",
-    "inputs": [{
-        "name": "owner",
-        "type": "string",
-        "label": "The owner of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The owner of the repository"
-    }, {
-        "name": "repository",
-        "type": "string",
-        "label": "The name of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the repository"
-    }, {
-        "name": "token",
-        "type": "string",
-        "label": "The access token to access GitHub with",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The access token to access GitHub with"
-    }, {
-        "name": "milestone",
-        "type": "string",
-        "label": "The milestone to use",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The milestone to use"
-    }, {
-        "name": "targetDirectory",
-        "type": "string",
-        "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
-    }]
-}
+    "inputs": [
+        {
+            "name": "owner",
+            "type": "string",
+            "label": "The owner of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The owner of the repository"
+        },
+        {
+            "name": "repository",
+            "type": "string",
+            "label": "The name of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the repository"
+        },
+        {
+            "name": "token",
+            "type": "string",
+            "label": "The access token to access GitHub with",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The access token to access GitHub with"
+        },
+        {
+            "name": "milestone",
+            "type": "string",
+            "label": "The milestone to use",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The milestone to use"
+        },
+        {
+            "name": "targetDirectory",
+            "type": "string",
+            "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
+        }
+    ]
+}

dist/azure/gitreleasemanager/open/task.json

@@ -12,49 +12,60 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/open",
-    "inputs": [{
-        "name": "owner",
-        "type": "string",
-        "label": "The owner of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The owner of the repository"
-    }, {
-        "name": "repository",
-        "type": "string",
-        "label": "The name of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the repository"
-    }, {
-        "name": "token",
-        "type": "string",
-        "label": "The access token to access GitHub with",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The access token to access GitHub with"
-    }, {
-        "name": "milestone",
-        "type": "string",
-        "label": "The milestone to use",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The milestone to use"
-    }, {
-        "name": "targetDirectory",
-        "type": "string",
-        "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
-    }]
-}
+    "inputs": [
+        {
+            "name": "owner",
+            "type": "string",
+            "label": "The owner of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The owner of the repository"
+        },
+        {
+            "name": "repository",
+            "type": "string",
+            "label": "The name of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the repository"
+        },
+        {
+            "name": "token",
+            "type": "string",
+            "label": "The access token to access GitHub with",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The access token to access GitHub with"
+        },
+        {
+            "name": "milestone",
+            "type": "string",
+            "label": "The milestone to use",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The milestone to use"
+        },
+        {
+            "name": "targetDirectory",
+            "type": "string",
+            "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
+        }
+    ]
+}

dist/azure/gitreleasemanager/publish/task.json

@@ -12,49 +12,60 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/publish",
-    "inputs": [{
-        "name": "owner",
-        "type": "string",
-        "label": "The owner of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The owner of the repository"
-    }, {
-        "name": "repository",
-        "type": "string",
-        "label": "The name of the repository",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the repository"
-    }, {
-        "name": "token",
-        "type": "string",
-        "label": "The access token to access GitHub with",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The access token to access GitHub with"
-    }, {
-        "name": "tagName",
-        "type": "string",
-        "label": "The name of the release",
-        "defaultValue": "",
-        "required": true,
-        "helpMarkDown": "The name of the release"
-    }, {
-        "name": "targetDirectory",
-        "type": "string",
-        "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
-        "defaultValue": "",
-        "required": false,
-        "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
-    }]
-}
+    "inputs": [
+        {
+            "name": "owner",
+            "type": "string",
+            "label": "The owner of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The owner of the repository"
+        },
+        {
+            "name": "repository",
+            "type": "string",
+            "label": "The name of the repository",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the repository"
+        },
+        {
+            "name": "token",
+            "type": "string",
+            "label": "The access token to access GitHub with",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The access token to access GitHub with"
+        },
+        {
+            "name": "tagName",
+            "type": "string",
+            "label": "The name of the release",
+            "defaultValue": "",
+            "required": true,
+            "helpMarkDown": "The name of the release"
+        },
+        {
+            "name": "targetDirectory",
+            "type": "string",
+            "label": "The directory on which GitReleaseManager should be executed. Defaults to current directory",
+            "defaultValue": "",
+            "required": false,
+            "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
+        }
+    ]
+}

dist/azure/gitreleasemanager/setup/task.json

@@ -12,16 +12,22 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitreleasemanager/setup",
-    "inputs": [{
+    "inputs": [
+        {
             "name": "versionSpec",
             "type": "string",
             "label": "The version spec",
@@ -36,6 +42,22 @@
             "defaultValue": "false",
             "required": false,
             "helpMarkDown": "Include pre-release versions when matching a version"
+        },
+        {
+            "name": "ignoreFailedSources",
+            "type": "boolean",
+            "label": "Treat package source failures as warnings",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Treat package source failures as warnings"
+        },
+        {
+            "name": "preferLatestVersion",
+            "type": "boolean",
+            "label": "Prefer latest version",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Prefer to download the latest version matching the versionSpec, even if there is a local cached version."
         }
     ]
-}
+}

dist/azure/gitversion/execute/task.json

@@ -2,7 +2,7 @@
     "id": "9013cf7f-ee8d-49f4-a39b-db244928d391",
     "name": "gitversion/execute",
     "friendlyName": "Execute GitVersion Task",
-    "description": "Easy Semantic Versioning (http://semver.org) for projects using Git",
+    "description": "Easy Semantic Versioning (https://semver.org) for projects using Git",
     "author": "GitTools Contributors",
     "helpMarkDown": "See the [documentation](https://gitversion.net/docs/) for help",
     "category": "Build",
@@ -12,16 +12,22 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitversion/execute",
-    "groups": [{
+    "groups": [
+        {
             "name": "gitversionDetails",
             "displayName": "GitVersion details",
             "isExpanded": true
@@ -32,7 +38,8 @@
             "isExpanded": false
         }
     ],
-    "inputs": [{
+    "inputs": [
+        {
             "name": "targetPath",
             "type": "string",
             "label": "Working directory path",
@@ -85,4 +92,4 @@
             "groupName": "additional"
         }
     ]
-}
+}

dist/azure/gitversion/setup/task.json

@@ -2,7 +2,7 @@
     "id": "a06c02ae-7b9a-4082-90dc-fe27b500e54f",
     "name": "gitversion/setup",
     "friendlyName": "Setup GitVersion Task",
-    "description": "Easy Semantic Versioning (http://semver.org) for projects using Git",
+    "description": "Easy Semantic Versioning (https://semver.org) for projects using Git",
     "author": "GitTools Contributors",
     "helpMarkDown": "See the [documentation](https://gitversion.net/docs/) for help",
     "category": "Build",
@@ -12,16 +12,22 @@
         "Minor": "0",
         "Patch": "0"
     },
-    "minimumAgentVersion": "2.115.0",
+    "minimumAgentVersion": "2.220.0",
     "execution": {
-        "Node": {
+        "Node10": {
+            "target": "bundle.js",
+            "argumentFormat": "",
+            "workingDirectory": "."
+        },
+        "Node20": {
             "target": "bundle.js",
             "argumentFormat": "",
             "workingDirectory": "."
         }
     },
     "instanceNameFormat": "gitversion/setup",
-    "inputs": [{
+    "inputs": [
+        {
             "name": "versionSpec",
             "type": "string",
             "label": "The version spec",
@@ -36,6 +42,22 @@
             "defaultValue": "false",
             "required": false,
             "helpMarkDown": "Include pre-release versions when matching a version"
+        },
+        {
+            "name": "ignoreFailedSources",
+            "type": "boolean",
+            "label": "Treat package source failures as warnings",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Treat package source failures as warnings"
+        },
+        {
+            "name": "preferLatestVersion",
+            "type": "boolean",
+            "label": "Prefer latest version",
+            "defaultValue": "false",
+            "required": false,
+            "helpMarkDown": "Prefer to download the latest version matching the versionSpec, even if there is a local cached version."
         }
     ]
-}
+}

dist/azure/overview.md

@@ -2,5 +2,10 @@ Versioning when using Git, solved. GitVersion looks at your Git history and work
 
 It works with most branching strategies but has been designed mainly around GitFlow and GitHubFlow (pull request workflow). The calculated version numbers can then be accessed through variables such as `$(GitVersion.NuGetVersion)` and `$(GitVersion.SemVer)`. It is also very configurable to allow it to work with most release workflows!
 
-![Build Task](https://raw.githubusercontent.com/GitTools/actions/master/dist/azure/images/build-task.png)
-![Builds](https://raw.githubusercontent.com/GitTools/actions/master/dist/azure/images/builds.png)
+## Azure Pipelines tasks
+
+![Azure Pipelines Tasks](images/pipeline-editor-tasks.png)
+
+## Azure Pipelines run examples
+
+![Azure Pipelines Runs](images/builds.png)

dist/azure/update-version.ps1

@@ -17,9 +17,9 @@ function update-task() {
     $patch
 )
     $file = Resolve-Path $file
-    $jqMajor = '.version.Major=\"' + $major +'\"';
-    $jqMinor = '.version.Minor=\"' + $minor +'\"';
-    $jqPatch = '.version.Patch=\"' + $patch +'\"';
+    $jqMajor = '.version.Major="' + $major +'"';
+    $jqMinor = '.version.Minor="' + $minor +'"';
+    $jqPatch = '.version.Patch="' + $patch +'"';
     Write-Host "Update task from $file to version $major.$minor.$patch"
 
     Get-Content $file | jq $jqMajor | jq $jqMinor| jq $jqPatch | Set-Content $file
@@ -36,8 +36,8 @@ function update-manifest() {
     $version
 )
     $file = Resolve-Path $file
-    $jqVersion = '.version=\"' + $version +'\"';
+    $jqVersion = '.version="' + $version +'"';
     Write-Host "Update manifest version to $version"
 
     Get-Content $file | jq $jqVersion | Set-Content $file
-}
+}

dist/azure/vss-extension.json

@@ -19,7 +19,8 @@
         { "path": "gitreleasemanager/close" },
         { "path": "gitreleasemanager/open" },
         { "path": "gitreleasemanager/publish" },
-        { "path": "gitreleasemanager/addasset" }
+        { "path": "gitreleasemanager/addasset" },
+        { "path": "images", "addressable": true }
     ],
     "categories": [
         "Azure Pipelines"
@@ -55,11 +56,18 @@
             "uri": "https://github.com/GitTools/actions/issues"
         }
     },
-    "screenshots": [{
-            "path": "images/builds.png"
+    "screenshots": [
+        {
+            "path": "screenshots/pipeline-editor-setup-gitversion-task.png"
         },
         {
-            "path": "images/build-task.png"
+            "path": "screenshots/pipeline-run-setup-gitversion-task.png"
+        },
+        {
+            "path": "screenshots/pipeline-editor-execute-gitversion-task.png"
+        },
+        {
+            "path": "screenshots/pipeline-run-execute-gitversion-task.png"
         }
     ],
     "content": {
@@ -149,4 +157,4 @@
             "name": "gitreleasemanager/addasset"
         }
     }]
-}
+}

docs/examples/azure/gitreleasemanager/close.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-    - task: gitreleasemanager/close@0
+  - task: gitreleasemanager/close@0
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

docs/examples/azure/gitreleasemanager/open.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-    - task: gitreleasemanager/open@0
+  - task: gitreleasemanager/open@0
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

docs/examples/azure/gitversion/execute/usage-examples.md

@@ -0,0 +1,417 @@
+# Execute GitVersion Task (gitversion/execute) Usage Examples
+
+Find out how to use the **gitversion/execute** task using the examples below.
+
+> The examples use the latest _0.x_ version of the GitVersion Execute task.  It is recommended to use the latest released version in your own pipelines.
+
+Note that if the pipeline is setup to use a shallow git fetch mode the GitVersion Execute task will fail. It is required to use fetchDepth of 0 like so:
+
+```yaml
+- checkout: self
+  fetchDepth: 0
+```
+
+## Inputs
+
+The Execute GitVersion task accepts the following inputs:
+
+```yaml
+targetPath:
+  description: Optionally supply the path to the working directory.
+  required: false
+  default: ''
+useConfigFile:
+  description: Whether to use a custom configuration file.
+  required: false
+  default: false
+configFilePath:
+  description: Optional path to config file (defaults to GitVersion.yml).
+  required: false
+  default: ''
+updateAssemblyInfo:
+  description: Whether to update versions in the AssemblyInfo files.
+  required: false
+  default: false
+updateAssemblyInfoFilename:
+  description: Update versions in specified file.
+  required: false
+  default: ''
+additionalArguments:
+  description: Additional arguments to send to GitVersion.
+  required: false
+  default: ''
+```
+
+## Outputs
+
+The Execute GitVersion task creates the following job-scoped variables and multi-job output variables:
+
+- major
+- minor
+- patch
+- preReleaseTag
+- preReleaseTagWithDash
+- preReleaseLabel
+- preReleaseNumber
+- weightedPreReleaseNumber
+- buildMetaData
+- buildMetaDataPadded (removed in 6.0.0)
+- fullBuildMetaData
+- majorMinorPatch
+- semVer
+- legacySemVer (removed in 6.0.0)
+- legacySemVerPadded (removed in 6.0.0)
+- assemblySemVer
+- assemblySemFileVer
+- fullSemVer
+- informationalVersion
+- branchName
+- escapedBranchName (since 5.2.0)
+- sha
+- shortSha
+- nuGetVersionV2 (removed in 6.0.0)
+- nuGetVersion (removed in 6.0.0)
+- nuGetPreReleaseTagV2 (removed in 6.0.0)
+- nuGetPreReleaseTag (removed in 6.0.0)
+- versionSourceSha
+- commitsSinceVersionSource
+- commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0)
+- uncommittedChanges (since 5.5.0)
+- commitDate
+
+The outputs can be accessed using the syntax `$(<id>.<outputName>)` or `$(<id>.GitVersion_<OutputName>)`, where `<id>` is the ID assigned to the step that calls the action, by subsequent steps later in the same job.  See example [5](#example-5).
+
+The action also creates environment variables of the form `$(<outputName>)` or `$(GitVersion_<OutputName>)` for use by other steps in the same job.  See example [6](#example-6).
+
+The multi-job output variables can be accessed across jobs and stages, in both conditions and variables. See examples [7](#example-7) to [10](#example-10).
+
+**GitVersion also automatically updates the pre-defined Build variable `Build.BuildNumber`.**
+
+---
+
+## Examples
+
+### Example 1
+
+Calculate the version for the build.
+
+```yaml
+steps:
+  # gitversion/setup@0 task omitted for brevity.
+
+  - task: gitversion/execute@0
+    displayName: Determine Version
+```
+
+### Example 2
+
+Calculate the version for the build using a config file with the default name **GitVersion.yml**.
+
+```yaml
+steps:
+  # gitversion/setup@0 task omitted for brevity.
+
+  - task: gitversion/execute@0
+    displayName: Determine Version
+    inputs:
+      useConfigFile: true
+```
+
+Example contents of **GitVersion.yml**:
+
+```yaml
+mode: Mainline
+branches:
+  master:
+    regex: ^latest$
+  pull-request:
+    tag: pr
+```
+
+### Example 3
+
+Calculate the version for the build using a config file named **VersionConfig.yml** in the root of the working folder.
+
+```yaml
+steps:
+  # gitversion/setup@0 task omitted for brevity.
+
+  - task: gitversion/execute@0
+    displayName: Determine Version
+    inputs:
+      useConfigFile: true
+      configFilePath: 'VersionConfig.yml'
+```
+
+### Example 4
+
+Show the effective configuration for GitVersion by running the **/showConfig** command (passed as an additional argument).
+
+```yaml
+steps:
+  # gitversion/setup@0 task omitted for brevity.
+
+  - task: gitversion/execute@0
+    displayName: Display GitVersion config
+    inputs:
+      additionalArguments: '/showConfig'
+```
+
+### Example 5
+
+Calculate the version for the build and display all the calculated variables in the next step.
+
+```yaml
+steps:
+  # gitversion/setup@0 task omitted for brevity.
+
+  - task: gitversion/execute@0
+    name: version # id to later be referenced
+    displayName: Determine Version
+
+  - displayName: Display GitVersion outputs (step output)
+    script: |
+      echo "Major: $(version.major)"
+      echo "Minor: $(version.minor)"
+      echo "Patch: $(version.patch)"
+      echo "PreReleaseTag: $(version.preReleaseTag)"
+      echo "PreReleaseTagWithDash: $(version.preReleaseTagWithDash)"
+      echo "PreReleaseLabel: $(version.preReleaseLabel)"
+      echo "PreReleaseNumber: $(version.preReleaseNumber)"
+      echo "WeightedPreReleaseNumber: $(version.weightedPreReleaseNumber)"
+      echo "BuildMetaData: $(version.buildMetaData)"
+      echo "BuildMetaDataPadded: $(version.buildMetaDataPadded)"
+      echo "FullBuildMetaData: $(version.fullBuildMetaData)"
+      echo "MajorMinorPatch: $(version.majorMinorPatch)"
+      echo "SemVer: $(version.semVer)"
+      echo "LegacySemVer: $(version.legacySemVer)"
+      echo "LegacySemVerPadded: $(version.legacySemVerPadded)"
+      echo "AssemblySemVer: $(version.assemblySemVer)"
+      echo "AssemblySemFileVer: $(version.assemblySemFileVer)"
+      echo "FullSemVer: $(version.fullSemVer)"
+      echo "InformationalVersion: $(version.informationalVersion)"
+      echo "BranchName: $(version.branchName)"
+      echo "EscapedBranchName: $(version.escapedBranchName)"
+      echo "Sha: $(version.sha)"
+      echo "ShortSha: $(version.shortSha)"
+      echo "NuGetVersionV2: $(version.nuGetVersionV2)"
+      echo "NuGetVersion: $(version.nuGetVersion)"
+      echo "NuGetPreReleaseTagV2: $(version.nuGetPreReleaseTagV2)"
+      echo "NuGetPreReleaseTag: $(version.nuGetPreReleaseTag)"
+      echo "VersionSourceSha: $(version.versionSourceSha)"
+      echo "CommitsSinceVersionSource: $(version.commitsSinceVersionSource)"
+      echo "CommitsSinceVersionSourcePadded: $(version.commitsSinceVersionSourcePadded)"
+      echo "UncommittedChanges: $(version.uncommittedChanges)"
+      echo "CommitDate: $(version.commitDate)"
+
+  - displayName: Display GitVersion outputs (step output with prefix)
+    script: |
+      echo "Major: $(version.GitVersion_Major)"
+      echo "Minor: $(version.GitVersion_Minor)"
+      echo "Patch: $(version.GitVersion_Patch)"
+      echo "PreReleaseTag: $(version.GitVersion_PreReleaseTag)"
+      echo "PreReleaseTagWithDash: $(version.GitVersion_PreReleaseTagWithDash)"
+      echo "PreReleaseLabel: $(version.GitVersion_PreReleaseLabel)"
+      echo "PreReleaseNumber: $(version.GitVersion_PreReleaseNumber)"
+      echo "WeightedPreReleaseNumber: $(version.GitVersion_WeightedPreReleaseNumber)"
+      echo "BuildMetaData: $(version.GitVersion_BuildMetaData)"
+      echo "BuildMetaDataPadded: $(version.GitVersion_BuildMetaDataPadded)"
+      echo "FullBuildMetaData: $(version.GitVersion_FullBuildMetaData)"
+      echo "MajorMinorPatch: $(version.GitVersion_MajorMinorPatch)"
+      echo "SemVer: $(version.GitVersion_SemVer)"
+      echo "LegacySemVer: $(version.GitVersion_LegacySemVer)"
+      echo "LegacySemVerPadded: $(version.GitVersion_LegacySemVerPadded)"
+      echo "AssemblySemVer: $(version.GitVersion_AssemblySemVer)"
+      echo "AssemblySemFileVer: $(version.GitVersion_AssemblySemFileVer)"
+      echo "FullSemVer: $(version.GitVersion_FullSemVer)"
+      echo "InformationalVersion: $(version.GitVersion_InformationalVersion)"
+      echo "BranchName: $(version.GitVersion_BranchName)"
+      echo "EscapedBranchName: $(version.GitVersion_EscapedBranchName)"
+      echo "Sha: $(version.GitVersion_Sha)"
+      echo "ShortSha: $(version.GitVersion_ShortSha)"
+      echo "NuGetVersionV2: $(version.GitVersion_NuGetVersionV2)"
+      echo "NuGetVersion: $(version.GitVersion_NuGetVersion)"
+      echo "NuGetPreReleaseTagV2: $(version.GitVersion_NuGetPreReleaseTagV2)"
+      echo "NuGetPreReleaseTag: $(version.GitVersion_NuGetPreReleaseTag)"
+      echo "VersionSourceSha: $(version.GitVersion_VersionSourceSha)"
+      echo "CommitsSinceVersionSource: $(version.GitVersion_CommitsSinceVersionSource)"
+      echo "CommitsSinceVersionSourcePadded: $(version.GitVersion_CommitsSinceVersionSourcePadded)"
+      echo "UncommittedChanges: $(version.GitVersion_UncommittedChanges)"
+      echo "CommitDate: $(version.GitVersion_CommitDate)"
+```
+
+### Example 6
+
+Calculate the version for the build and use the `GitVersion.NuGetVersion` variable to set the NuGet package version.
+
+```yaml
+steps:
+  # gitversion/setup@0 task omitted for brevity.
+
+  - task: gitversion/execute@0
+    displayName: Determine Version
+
+  - displayName: Display GitVersion variables (without prefix)
+    script: |
+      echo "Major: $(major)"
+      echo "Minor: $(minor)"
+      echo "Patch: $(patch)"
+      echo "PreReleaseTag: $(preReleaseTag)"
+      echo "PreReleaseTagWithDash: $(preReleaseTagWithDash)"
+      echo "PreReleaseLabel: $(preReleaseLabel)"
+      echo "PreReleaseNumber: $(preReleaseNumber)"
+      echo "WeightedPreReleaseNumber: $(weightedPreReleaseNumber)"
+      echo "BuildMetaData: $(buildMetaData)"
+      echo "BuildMetaDataPadded: $(buildMetaDataPadded)"
+      echo "FullBuildMetaData: $(fullBuildMetaData)"
+      echo "MajorMinorPatch: $(majorMinorPatch)"
+      echo "SemVer: $(semVer)"
+      echo "LegacySemVer: $(legacySemVer)"
+      echo "LegacySemVerPadded: $(legacySemVerPadded)"
+      echo "AssemblySemVer: $(assemblySemVer)"
+      echo "AssemblySemFileVer: $(assemblySemFileVer)"
+      echo "FullSemVer: $(fullSemVer)"
+      echo "InformationalVersion: $(informationalVersion)"
+      echo "BranchName: $(branchName)"
+      echo "EscapedBranchName: $(escapedBranchName)"
+      echo "Sha: $(sha)"
+      echo "ShortSha: $(shortSha)"
+      echo "NuGetVersionV2: $(nuGetVersionV2)"
+      echo "NuGetVersion: $(nuGetVersion)"
+      echo "NuGetPreReleaseTagV2: $(nuGetPreReleaseTagV2)"
+      echo "NuGetPreReleaseTag: $(nuGetPreReleaseTag)"
+      echo "VersionSourceSha: $(versionSourceSha)"
+      echo "CommitsSinceVersionSource: $(commitsSinceVersionSource)"
+      echo "CommitsSinceVersionSourcePadded: $(commitsSinceVersionSourcePadded)"
+      echo "UncommittedChanges: $(uncommittedChanges)"
+      echo "CommitDate: $(commitDate)"
+
+  - displayName: Display GitVersion variables (with prefix)
+    script: |
+      echo "Major: $(GitVersion_Major)"
+      echo "Minor: $(GitVersion_Minor)"
+      echo "Patch: $(GitVersion_Patch)"
+      echo "PreReleaseTag: $(GitVersion_PreReleaseTag)"
+      echo "PreReleaseTagWithDash: $(GitVersion_PreReleaseTagWithDash)"
+      echo "PreReleaseLabel: $(GitVersion_PreReleaseLabel)"
+      echo "PreReleaseNumber: $(GitVersion_PreReleaseNumber)"
+      echo "WeightedPreReleaseNumber: $(GitVersion_WeightedPreReleaseNumber)"
+      echo "BuildMetaData: $(GitVersion_BuildMetaData)"
+      echo "BuildMetaDataPadded: $(GitVersion_BuildMetaDataPadded)"
+      echo "FullBuildMetaData: $(GitVersion_FullBuildMetaData)"
+      echo "MajorMinorPatch: $(GitVersion_MajorMinorPatch)"
+      echo "SemVer: $(GitVersion_SemVer)"
+      echo "LegacySemVer: $(GitVersion_LegacySemVer)"
+      echo "LegacySemVerPadded: $(GitVersion_LegacySemVerPadded)"
+      echo "AssemblySemVer: $(GitVersion_AssemblySemVer)"
+      echo "AssemblySemFileVer: $(GitVersion_AssemblySemFileVer)"
+      echo "FullSemVer: $(GitVersion_FullSemVer)"
+      echo "InformationalVersion: $(GitVersion_InformationalVersion)"
+      echo "BranchName: $(GitVersion_BranchName)"
+      echo "EscapedBranchName: $(GitVersion_EscapedBranchName)"
+      echo "Sha: $(GitVersion_Sha)"
+      echo "ShortSha: $(GitVersion_ShortSha)"
+      echo "NuGetVersionV2: $(GitVersion_NuGetVersionV2)"
+      echo "NuGetVersion: $(GitVersion_NuGetVersion)"
+      echo "NuGetPreReleaseTagV2: $(GitVersion_NuGetPreReleaseTagV2)"
+      echo "NuGetPreReleaseTag: $(GitVersion_NuGetPreReleaseTag)"
+      echo "VersionSourceSha: $(GitVersion_VersionSourceSha)"
+      echo "CommitsSinceVersionSource: $(GitVersion_CommitsSinceVersionSource)"
+      echo "CommitsSinceVersionSourcePadded: $(GitVersion_CommitsSinceVersionSourcePadded)"
+      echo "UncommittedChanges: $(GitVersion_UncommittedChanges)"
+      echo "CommitDate: $(GitVersion_CommitDate)"
+
+  - task: DotNetCoreCLI@2
+    displayName: Pack Example
+    inputs:
+      command: pack
+      packagesToPack: src/Example/LibExample.csproj
+      versioningScheme: byEnvVar
+      versionEnvVar: GitVersion_SemVer # alternative syntax GITVERSION_SEMVER (the former gets converted into the latter internally)
+```
+
+### Example 7
+
+Calculate the version for the build and use the `GitVersion_BranchName` variable in a condition for starting another job.
+
+```yaml
+jobs:
+  - job: CalculateVersion
+    displayName: Calculate version using GitVersion
+    steps:
+      # gitversion/setup@0 task omitted for brevity.
+
+      - task: gitversion/execute@0
+        displayName: Use GitVersion
+        name: Version # the step MUST be named to access its output variables in another job.
+
+  - job: CreateReleaseNotes
+    condition: and(succeeded(), eq(dependencies.CalculateVersion.outputs['Version.GitVersion_BranchName'], 'main'))
+    dependsOn: CalculateVersion
+```
+
+### Example 8
+
+Calculate the version for the build and map the `GitVersion_SemVer` variable into a variable in another job.
+
+```yaml
+jobs:
+  - job: CalculateVersion
+    displayName: Calculate version using GitVersion
+    steps:
+      # gitversion/setup@0 task omitted for brevity.
+
+      - task: gitversion/execute@0
+        displayName: Use GitVersion
+        name: Version # the step MUST be named to access its output variables in another job.
+
+  - job: BuildAndPack
+    variables:
+      Ver.MajorMinorPatch: $[ dependencies.CalculateVersion.outputs['Version.GitVersion_MajorMinorPatch'] ]
+```
+
+### Example 9
+
+Calculate the version for the build and use the `GitVersion.Major` output variable in a condition for starting another stage.
+
+```yaml
+stages:
+  - stage: S1
+    jobs:
+      - job: CalculateVersion
+        displayName: Calculate version number using GitVersion
+        steps:
+          # gitversion/setup@0 task omitted for brevity.
+
+          - task: gitversion/execute@0
+            displayName: Use GitVersion
+            name: Version # the step MUST be named to access its output variables in another stage.
+
+  - stage: S2
+    condition: and(succeeded(), gt(dependencies.S1.outputs['CalculateVersion.Version.GitVersion_Major'], 0))
+    dependsOn: S1
+```
+
+### Example 10
+
+Calculate the version for the build and map the `GitVersion.AssemblySemVer` variable into a variable in another job for a different stage.
+
+```yaml
+stages:
+  - stage: S1
+    jobs:
+      - job: CalculateVersion
+        displayName: Calculate version number using GitVersion
+        steps:
+          # gitversion/setup@0 task omitted for brevity.
+
+          - task: gitversion/execute@0
+            displayName: Use GitVersion
+            name: Version # the step MUST be named to access its output variables in another stage.
+  - stage: S2
+    dependsOn: S1
+    jobs:
+      - job: UpdateAssemblyVersions
+        variables:
+          Ver.AssemblyVer: $[ stageDependencies.S1.CalculateVersion.outputs['Version.GitVersion_AssemblySemVer'] ] # Note the 'stageDependencies.<jobName>' syntax.
+```

docs/examples/azure/gitversion/index.md

@@ -1,43 +1,11 @@
-# Example
+# GitVersion Tasks Usage Examples
 
-```yaml
-  steps:
-  - task: gitversion/setup@0
-    displayName: Install GitVersion
-    inputs:
-      versionSpec: '5.1.3'
-  - task: gitversion/execute@0
-    displayName: Use GitVersion
-  - script: |
-      echo FullSemVer: $(fullSemVer)
-      echo ##vso[build.updatebuildnumber]$(fullSemVer)
-      echo Major: ${{ steps.gitversion.outputs.major }}
-      echo Minor: ${{ steps.gitversion.outputs.minor }}
-      echo Patch: ${{ steps.gitversion.outputs.patch }}
-      echo PreReleaseTag: ${{ steps.gitversion.outputs.preReleaseTag }}
-      echo PreReleaseTagWithDash: ${{ steps.gitversion.outputs.preReleaseTagWithDash }}
-      echo PreReleaseLabel: ${{ steps.gitversion.outputs.preReleaseLabel }}
-      echo PreReleaseNumber: ${{ steps.gitversion.outputs.preReleaseNumber }}
-      echo WeightedPreReleaseNumber: ${{ steps.gitversion.outputs.weightedPreReleaseNumber }}
-      echo BuildMetaData: ${{ steps.gitversion.outputs.buildMetaData }}
-      echo BuildMetaDataPadded: ${{ steps.gitversion.outputs.buildMetaDataPadded }}
-      echo FullBuildMetaData: ${{ steps.gitversion.outputs.fullBuildMetaData }}
-      echo MajorMinorPatch: ${{ steps.gitversion.outputs.majorMinorPatch }}
-      echo SemVer: ${{ steps.gitversion.outputs.semVer }}
-      echo LegacySemVer: ${{ steps.gitversion.outputs.legacySemVer }}
-      echo LegacySemVerPadded: ${{ steps.gitversion.outputs.legacySemVerPadded }}
-      echo AssemblySemVer: ${{ steps.gitversion.outputs.assemblySemVer }}
-      echo AssemblySemFileVer: ${{ steps.gitversion.outputs.assemblySemFileVer }}
-      echo InformationalVersion: ${{ steps.gitversion.outputs.informationalVersion }}
-      echo BranchName: ${{ steps.gitversion.outputs.branchName }}
-      echo Sha: ${{ steps.gitversion.outputs.sha }}
-      echo ShortSha: ${{ steps.gitversion.outputs.shortSha }}
-      echo NuGetVersionV2: ${{ steps.gitversion.outputs.nuGetVersionV2 }}
-      echo NuGetVersion: ${{ steps.gitversion.outputs.nuGetVersion }}
-      echo NuGetPreReleaseTagV2: ${{ steps.gitversion.outputs.nuGetPreReleaseTagV2 }}
-      echo NuGetPreReleaseTag: ${{ steps.gitversion.outputs.nuGetPreReleaseTag }}
-      echo VersionSourceSha: ${{ steps.gitversion.outputs.versionSourceSha }}
-      echo CommitsSinceVersionSource: ${{ steps.gitversion.outputs.commitsSinceVersionSource }}
-      echo CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.commitsSinceVersionSourcePadded }}
-      echo CommitDate: ${{ steps.gitversion.outputs.commitDate }}
-```
+Use the following links to see usage examples of the Setup GitVersion (**gitversion/setup**) and Execute GitVersion (**gitversion/execute**) tasks.
+
+## Setup GitVersion (gitversion/setup)
+
+- [Usage examples](setup/usage-examples.md)
+
+## Execute GitVersion (gitversion/execute)
+
+- [Usage examples](execute/usage-examples.md)

docs/examples/azure/gitversion/setup/usage-examples.md

@@ -0,0 +1,90 @@
+# 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
+ignoreFailedSources:
+  description: Treat package source failures as warnings.
+  required: false
+  default: false
+preferLatestVersion:
+  description: Prefer to download the latest version matching the versionSpec, even if there is a local cached version.
+  required: false
+  default: 'false'
+```
+
+---
+
+## Usage examples
+
+In order for the gitversion to properly work you need to clone the repository with the entire history:
+
+```yaml
+steps:
+  - checkout: self
+    fetchDepth: 0
+```
+
+### 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
+```
+
+### Example 4
+
+Install the latest GitVersion 5 version even it there is a cached version matching the versionSpec.
+
+```yaml
+steps:
+  - task: gitversion/setup@0
+    displayName: Install GitVersion
+    inputs:
+      versionSpec: '5.x'
+      preferLatestVersion: true
+```

docs/examples/github/gitreleasemanager/addasset.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/addasset@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/addasset@v0
     name: Add asset to a release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

docs/examples/github/gitreleasemanager/close.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/close@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/close@v0
     name: Close release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

docs/examples/github/gitreleasemanager/create.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/create@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/create@0
     name: Create release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

docs/examples/github/gitreleasemanager/discard.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/discard@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/discard@v0
     name: Discard release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

docs/examples/github/gitreleasemanager/open.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/open@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/open@v0
     name: Open release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

docs/examples/github/gitreleasemanager/publish.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/publish@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/publish@v0
     name: Publish release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

docs/examples/github/gitreleasemanager/setup.md

@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/setup@v0.9.2
+  - uses: gittools/actions/gitreleasemanager/setup@v0
     name: Install GitReleaseManager
     with:
       versionSpec: '0.10.x'

docs/examples/github/gitversion/execute/usage-examples.md

@@ -0,0 +1,385 @@
+# Execute GitVersion Action (gitversion/execute) Usage Examples
+
+Find out how to use the **gitversion/execute** action using the examples below.
+
+For the GitVersion workflow to execute successfully, you must checkout your Git repository with `fetch-depth: 0` to fetch all history for all tags and branches, as follows:
+
+```yaml
+steps:
+  - name: Checkout
+    uses: actions/checkout@v2
+    with:
+      fetch-depth: 0
+```
+
+This step is omitted from the examples for brevity.
+
+> The examples use version _0.9.7_ of the GitVersion Execute action.  It is recommended to use the latest released version in your own workflows.
+
+## Inputs
+
+The Execute GitVersion action accepts the following inputs:
+
+```yaml
+targetPath:
+  description: Optionally supply the path to the working directory.
+  required: false
+  default: ''
+useConfigFile:
+  description: Whether to use a custom configuration file.
+  required: false
+  default: false
+configFilePath:
+  description: Optional path to config file (defaults to GitVersion.yml).
+  required: false
+  default: 'GitVersion.yml'
+updateAssemblyInfo:
+  description: Whether to update versions in the AssemblyInfo files.
+  required: false
+  default: false
+updateAssemblyInfoFilename:
+  description: Update versions in specified file.
+  required: false
+  default: ''
+additionalArguments:
+  description: Additional arguments to send to GitVersion.
+  required: false
+  default: ''
+```
+
+## Outputs
+
+The Execute GitVersion action creates the following outputs:
+
+- major
+- minor
+- patch
+- preReleaseTag
+- preReleaseTagWithDash
+- preReleaseLabel
+- preReleaseNumber
+- weightedPreReleaseNumber
+- buildMetaData
+- buildMetaDataPadded (removed in 6.0.0)
+- fullBuildMetaData
+- majorMinorPatch
+- semVer
+- legacySemVer (removed in 6.0.0)
+- legacySemVerPadded (removed in 6.0.0)
+- assemblySemVer
+- assemblySemFileVer
+- fullSemVer
+- informationalVersion
+- branchName
+- escapedBranchName (since 5.2.0)
+- sha
+- shortSha
+- nuGetVersionV2 (removed in 6.0.0)
+- nuGetVersion (removed in 6.0.0)
+- nuGetPreReleaseTagV2 (removed in 6.0.0)
+- nuGetPreReleaseTag (removed in 6.0.0)
+- versionSourceSha
+- commitsSinceVersionSource
+- commitsSinceVersionSourcePadded (since 5.2.0, removed in 6.0.0)
+- uncommittedChanges (since 5.5.0)
+- commitDate
+
+The outputs can be accessed using the syntax `${{ steps.<id>.outputs.<outputName> }}` or `${{ steps.<id>.outputs.GitVersion_<OutputName> }}`, where `<id>` is the ID assigned to the step that calls the action, by subsequent steps later in the same job.  See example [5](#example-5).
+
+The action also creates environment variables of the form `${{ env.<outputName> }}` or `${{ env.GitVersion_<OutputName> }}` for use by other steps in the same job.  See example [6](#example-6).
+
+The outputs can be accessed across jobs by mapping them to job outputs and referencing the job outputs using the `needs` context in dependent jobs.  See examples [7](#example-7) and [8](#example-8).
+
+---
+
+## Examples
+
+### Example 1
+
+Calculate the version for the build.
+
+```yaml
+steps:
+  # gitversion/setup@v0 action omitted for brevity.
+
+  - name: Determine Version
+    uses: gittools/actions/gitversion/execute@v0
+```
+
+### Example 2
+
+Calculate the version for the build using a config file with the default name **GitVersion.yml**.
+
+```yaml
+steps:
+  - name: Determine Version
+    uses: gittools/actions/gitversion/execute@v0
+    with:
+      useConfigFile: true
+```
+
+Example contents of **GitVersion.yml**:
+
+```yaml
+mode: Mainline
+branches:
+  master:
+    regex: ^latest$
+  pull-request:
+    tag: pr
+```
+
+### Example 3
+
+Calculate the version for the build using a config file named **VersionConfig.yml** in the root of the working folder.
+
+```yaml
+steps:
+  # gitversion/setup@v0 action omitted for brevity.
+
+  - name: Determine Version
+    uses: gittools/actions/gitversion/execute@v0
+    with:
+      useConfigFile: true
+      configFilePath: VersionConfig.yml
+```
+
+### Example 4
+
+Show the effective configuration for GitVersion by running the **/showConfig** command (passed as an additional argument).
+
+```yaml
+steps:
+  # gitversion/setup@v0 action omitted for brevity.
+
+  - name: Display GitVersion config
+    uses: gittools/actions/gitversion/execute@v0
+    with:
+      useConfigFile: true
+      additionalArguments: '/showConfig'
+```
+
+### Example 5
+
+Calculate the version for the build and display all the calculated variables in the next step.
+
+```yaml
+steps:
+  # gitversion/setup@v0 action omitted for brevity.
+
+  - name: Determine Version
+    id:   gitversion # id to later be referenced
+    uses: gittools/actions/gitversion/execute@v0
+
+  - name: Display GitVersion outputs (step output)
+    run: |
+      echo "Major: ${{ steps.gitversion.outputs.major }}"
+      echo "Minor: ${{ steps.gitversion.outputs.minor }}"
+      echo "Patch: ${{ steps.gitversion.outputs.patch }}"
+      echo "PreReleaseTag: ${{ steps.gitversion.outputs.preReleaseTag }}"
+      echo "PreReleaseTagWithDash: ${{ steps.gitversion.outputs.preReleaseTagWithDash }}"
+      echo "PreReleaseLabel: ${{ steps.gitversion.outputs.preReleaseLabel }}"
+      echo "PreReleaseNumber: ${{ steps.gitversion.outputs.preReleaseNumber }}"
+      echo "WeightedPreReleaseNumber: ${{ steps.gitversion.outputs.weightedPreReleaseNumber }}"
+      echo "BuildMetaData: ${{ steps.gitversion.outputs.buildMetaData }}"
+      echo "BuildMetaDataPadded: ${{ steps.gitversion.outputs.buildMetaDataPadded }}"
+      echo "FullBuildMetaData: ${{ steps.gitversion.outputs.fullBuildMetaData }}"
+      echo "MajorMinorPatch: ${{ steps.gitversion.outputs.majorMinorPatch }}"
+      echo "SemVer: ${{ steps.gitversion.outputs.semVer }}"
+      echo "LegacySemVer: ${{ steps.gitversion.outputs.legacySemVer }}"
+      echo "LegacySemVerPadded: ${{ steps.gitversion.outputs.legacySemVerPadded }}"
+      echo "AssemblySemVer: ${{ steps.gitversion.outputs.assemblySemVer }}"
+      echo "AssemblySemFileVer: ${{ steps.gitversion.outputs.assemblySemFileVer }}"
+      echo "FullSemVer: ${{ steps.gitversion.outputs.fullSemVer }}"
+      echo "InformationalVersion: ${{ steps.gitversion.outputs.informationalVersion }}"
+      echo "BranchName: ${{ steps.gitversion.outputs.branchName }}"
+      echo "EscapedBranchName: ${{ steps.gitversion.outputs.escapedBranchName }}"
+      echo "Sha: ${{ steps.gitversion.outputs.sha }}"
+      echo "ShortSha: ${{ steps.gitversion.outputs.shortSha }}"
+      echo "NuGetVersionV2: ${{ steps.gitversion.outputs.nuGetVersionV2 }}"
+      echo "NuGetVersion: ${{ steps.gitversion.outputs.nuGetVersion }}"
+      echo "NuGetPreReleaseTagV2: ${{ steps.gitversion.outputs.nuGetPreReleaseTagV2 }}"
+      echo "NuGetPreReleaseTag: ${{ steps.gitversion.outputs.nuGetPreReleaseTag }}"
+      echo "VersionSourceSha: ${{ steps.gitversion.outputs.versionSourceSha }}"
+      echo "CommitsSinceVersionSource: ${{ steps.gitversion.outputs.commitsSinceVersionSource }}"
+      echo "CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.commitsSinceVersionSourcePadded }}"
+      echo "UncommittedChanges: ${{ steps.gitversion.outputs.uncommittedChanges }}"
+      echo "CommitDate: ${{ steps.gitversion.outputs.commitDate }}"
+
+  - name: Display GitVersion outputs (step output with prefix)
+    run: |
+      echo "Major: ${{ steps.gitversion.outputs.GitVersion_Major }}"
+      echo "Minor: ${{ steps.gitversion.outputs.GitVersion_Minor }}"
+      echo "Patch: ${{ steps.gitversion.outputs.GitVersion_Patch }}"
+      echo "PreReleaseTag: ${{ steps.gitversion.outputs.GitVersion_PreReleaseTag }}"
+      echo "PreReleaseTagWithDash: ${{ steps.gitversion.outputs.GitVersion_PreReleaseTagWithDash }}"
+      echo "PreReleaseLabel: ${{ steps.gitversion.outputs.GitVersion_PreReleaseLabel }}"
+      echo "PreReleaseNumber: ${{ steps.gitversion.outputs.GitVersion_PreReleaseNumber }}"
+      echo "WeightedPreReleaseNumber: ${{ steps.gitversion.outputs.GitVersion_WeightedPreReleaseNumber }}"
+      echo "BuildMetaData: ${{ steps.gitversion.outputs.GitVersion_BuildMetaData }}"
+      echo "BuildMetaDataPadded: ${{ steps.gitversion.outputs.GitVersion_BuildMetaDataPadded }}"
+      echo "FullBuildMetaData: ${{ steps.gitversion.outputs.GitVersion_FullBuildMetaData }}"
+      echo "MajorMinorPatch: ${{ steps.gitversion.outputs.GitVersion_MajorMinorPatch }}"
+      echo "SemVer: ${{ steps.gitversion.outputs.GitVersion_SemVer }}"
+      echo "LegacySemVer: ${{ steps.gitversion.outputs.GitVersion_LegacySemVer }}"
+      echo "LegacySemVerPadded: ${{ steps.gitversion.outputs.GitVersion_LegacySemVerPadded }}"
+      echo "AssemblySemVer: ${{ steps.gitversion.outputs.GitVersion_AssemblySemVer }}"
+      echo "AssemblySemFileVer: ${{ steps.gitversion.outputs.GitVersion_AssemblySemFileVer }}"
+      echo "FullSemVer: ${{ steps.gitversion.outputs.GitVersion_FullSemVer }}"
+      echo "InformationalVersion: ${{ steps.gitversion.outputs.GitVersion_InformationalVersion }}"
+      echo "BranchName: ${{ steps.gitversion.outputs.GitVersion_BranchName }}"
+      echo "EscapedBranchName: ${{ steps.gitversion.outputs.GitVersion_EscapedBranchName }}"
+      echo "Sha: ${{ steps.gitversion.outputs.GitVersion_Sha }}"
+      echo "ShortSha: ${{ steps.gitversion.outputs.GitVersion_ShortSha }}"
+      echo "NuGetVersionV2: ${{ steps.gitversion.outputs.GitVersion_NuGetVersionV2 }}"
+      echo "NuGetVersion: ${{ steps.gitversion.outputs.GitVersion_NuGetVersion }}"
+      echo "NuGetPreReleaseTagV2: ${{ steps.gitversion.outputs.GitVersion_NuGetPreReleaseTagV2 }}"
+      echo "NuGetPreReleaseTag: ${{ steps.gitversion.outputs.GitVersion_NuGetPreReleaseTag }}"
+      echo "VersionSourceSha: ${{ steps.gitversion.outputs.GitVersion_VersionSourceSha }}"
+      echo "CommitsSinceVersionSource: ${{ steps.gitversion.outputs.GitVersion_CommitsSinceVersionSource }}"
+      echo "CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.GitVersion_CommitsSinceVersionSourcePadded }}"
+      echo "UncommittedChanges: ${{ steps.gitversion.outputs.GitVersion_UncommittedChanges }}"
+      echo "CommitDate: ${{ steps.gitversion.outputs.GitVersion_CommitDate }}"
+```
+
+### Example 6
+
+Calculate the version for the build and display the value of the `env.GitVersion_SemVer` environment variable.
+
+```yaml
+steps:
+  # gitversion/setup@v0 action omitted for brevity.
+
+  - name: Determine Version
+    uses: gittools/actions/gitversion/execute@v0
+
+
+  - name: Display GitVersion variables (without prefix)
+    run: |
+      echo "Major: ${{ env.major }}"
+      echo "Minor: ${{ env.minor }}"
+      echo "Patch: ${{ env.patch }}"
+      echo "PreReleaseTag: ${{ env.preReleaseTag }}"
+      echo "PreReleaseTagWithDash: ${{ env.preReleaseTagWithDash }}"
+      echo "PreReleaseLabel: ${{ env.preReleaseLabel }}"
+      echo "PreReleaseNumber: ${{ env.preReleaseNumber }}"
+      echo "WeightedPreReleaseNumber: ${{ env.weightedPreReleaseNumber }}"
+      echo "BuildMetaData: ${{ env.buildMetaData }}"
+      echo "BuildMetaDataPadded: ${{ env.buildMetaDataPadded }}"
+      echo "FullBuildMetaData: ${{ env.fullBuildMetaData }}"
+      echo "MajorMinorPatch: ${{ env.majorMinorPatch }}"
+      echo "SemVer: ${{ env.semVer }}"
+      echo "LegacySemVer: ${{ env.legacySemVer }}"
+      echo "LegacySemVerPadded: ${{ env.legacySemVerPadded }}"
+      echo "AssemblySemVer: ${{ env.assemblySemVer }}"
+      echo "AssemblySemFileVer: ${{ env.assemblySemFileVer }}"
+      echo "FullSemVer: ${{ env.fullSemVer }}"
+      echo "InformationalVersion: ${{ env.informationalVersion }}"
+      echo "BranchName: ${{ env.branchName }}"
+      echo "EscapedBranchName: ${{ env.escapedBranchName }}"
+      echo "Sha: ${{ env.sha }}"
+      echo "ShortSha: ${{ env.shortSha }}"
+      echo "NuGetVersionV2: ${{ env.nuGetVersionV2 }}"
+      echo "NuGetVersion: ${{ env.nuGetVersion }}"
+      echo "NuGetPreReleaseTagV2: ${{ env.nuGetPreReleaseTagV2 }}"
+      echo "NuGetPreReleaseTag: ${{ env.nuGetPreReleaseTag }}"
+      echo "VersionSourceSha: ${{ env.versionSourceSha }}"
+      echo "CommitsSinceVersionSource: ${{ env.commitsSinceVersionSource }}"
+      echo "CommitsSinceVersionSourcePadded: ${{ env.commitsSinceVersionSourcePadded }}"
+      echo "UncommittedChanges: ${{ env.uncommittedChanges }}"
+      echo "CommitDate: ${{ env.commitDate }}"
+
+  - name: Display GitVersion variables (with prefix)
+    run: |
+      echo "Major: ${{ env.GitVersion_Major }}"
+      echo "Minor: ${{ env.GitVersion_Minor }}"
+      echo "Patch: ${{ env.GitVersion_Patch }}"
+      echo "PreReleaseTag: ${{ env.GitVersion_PreReleaseTag }}"
+      echo "PreReleaseTagWithDash: ${{ env.GitVersion_PreReleaseTagWithDash }}"
+      echo "PreReleaseLabel: ${{ env.GitVersion_PreReleaseLabel }}"
+      echo "PreReleaseNumber: ${{ env.GitVersion_PreReleaseNumber }}"
+      echo "WeightedPreReleaseNumber: ${{ env.GitVersion_WeightedPreReleaseNumber }}"
+      echo "BuildMetaData: ${{ env.GitVersion_BuildMetaData }}"
+      echo "BuildMetaDataPadded: ${{ env.GitVersion_BuildMetaDataPadded }}"
+      echo "FullBuildMetaData: ${{ env.GitVersion_FullBuildMetaData }}"
+      echo "MajorMinorPatch: ${{ env.GitVersion_MajorMinorPatch }}"
+      echo "SemVer: ${{ env.GitVersion_SemVer }}"
+      echo "LegacySemVer: ${{ env.GitVersion_LegacySemVer }}"
+      echo "LegacySemVerPadded: ${{ env.GitVersion_LegacySemVerPadded }}"
+      echo "AssemblySemVer: ${{ env.GitVersion_AssemblySemVer }}"
+      echo "AssemblySemFileVer: ${{ env.GitVersion_AssemblySemFileVer }}"
+      echo "FullSemVer: ${{ env.GitVersion_FullSemVer }}"
+      echo "InformationalVersion: ${{ env.GitVersion_InformationalVersion }}"
+      echo "BranchName: ${{ env.GitVersion_BranchName }}"
+      echo "EscapedBranchName: ${{ env.GitVersion_EscapedBranchName }}"
+      echo "Sha: ${{ env.GitVersion_Sha }}"
+      echo "ShortSha: ${{ env.GitVersion_ShortSha }}"
+      echo "NuGetVersionV2: ${{ env.GitVersion_NuGetVersionV2 }}"
+      echo "NuGetVersion: ${{ env.GitVersion_NuGetVersion }}"
+      echo "NuGetPreReleaseTagV2: ${{ env.GitVersion_NuGetPreReleaseTagV2 }}"
+      echo "NuGetPreReleaseTag: ${{ env.GitVersion_NuGetPreReleaseTag }}"
+      echo "VersionSourceSha: ${{ env.GitVersion_VersionSourceSha }}"
+      echo "CommitsSinceVersionSource: ${{ env.GitVersion_CommitsSinceVersionSource }}"
+      echo "CommitsSinceVersionSourcePadded: ${{ env.GitVersion_CommitsSinceVersionSourcePadded }}"
+      echo "UncommittedChanges: ${{ env.GitVersion_UncommittedChanges }}"
+      echo "CommitDate: ${{ env.GitVersion_CommitDate }}"
+```
+
+### Example 7
+
+Calculate the version for the build and use the `branchName` output in a condition for starting another job.
+
+```yaml
+jobs:
+  calculate-version:
+    name: Calculate Version
+    runs-on: ubuntu-latest
+    outputs:
+      branchName: ${{ steps.gitversion.outputs.branchName }} # To use an output in another job, you have to map it to a job output.
+    steps:
+      # gitversion/execute step omitted for brevity
+
+      - name: Determine Version
+        id: gitversion
+        uses: gittools/actions/gitversion/execute@v0
+
+  create-release-notes:
+    name: Create Release Notes
+    runs-on: ubuntu-latest
+    needs: calculate-version
+    if: contains(needs.calculate-version.outputs.branchName, 'main') # Output variable accessed via `needs` context.
+    steps:
+      - run: |
+          # Output variables can also be accessed in steps, using an expression.
+          echo "Creating release notes for ${{ needs.calculate-version.outputs.branchName }} branch."
+```
+
+### Example 8
+
+Calculate the version for the build and map the `semVer` output into an environment variable in another job.
+
+```yaml
+jobs:
+  calculate-version:
+    name: Calculate Version
+    runs-on: ubuntu-latest
+    outputs:
+      semVer: ${{ steps.gitversion.outputs.semVer }}
+    steps:
+      # gitversion/execute step omitted for brevity
+
+      - name: Determine Version
+        id: gitversion
+        uses: gittools/actions/gitversion/execute@v0
+
+  display-semver:
+    name: Display Semantic Version
+    runs-on: ubuntu-latest
+    needs: calculate-version
+    env:
+      SEMVER: ${{ needs.calculate-version.outputs.semVer }}
+    steps:
+      - name: Display version
+        run: |
+          echo SemVer: $SEMVER
+```

docs/examples/github/gitversion/index.md

@@ -1,50 +1,11 @@
-# GitVersion
+# GitVersion Actions Usage Examples
 
-For the GitVersion workflow to execute successfully, you must checkout your Git
-repository with `fetch-depth: 0` to fetch all history for all tags and branches.
+Use the following links to see usage examples of the Setup GitVersion (**gitversion/setup**) and Execute GitVersion (**gitversion/execute**) actions.
 
-```yaml
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-    - name: Install GitVersion
-      uses: gittools/actions/gitversion/setup@v0.9.4
-      with:
-        versionSpec: '5.3.x'
-    - name: Use GitVersion
-      id: gitversion # step id used as reference for output values
-      uses: gittools/actions/gitversion/execute@v0.9.4
-    - run: |
-        echo "Major: ${{ steps.gitversion.outputs.major }}"
-        echo "Minor: ${{ steps.gitversion.outputs.minor }}"
-        echo "Patch: ${{ steps.gitversion.outputs.patch }}"
-        echo "PreReleaseTag: ${{ steps.gitversion.outputs.preReleaseTag }}"
-        echo "PreReleaseTagWithDash: ${{ steps.gitversion.outputs.preReleaseTagWithDash }}"
-        echo "PreReleaseLabel: ${{ steps.gitversion.outputs.preReleaseLabel }}"
-        echo "PreReleaseNumber: ${{ steps.gitversion.outputs.preReleaseNumber }}"
-        echo "WeightedPreReleaseNumber: ${{ steps.gitversion.outputs.weightedPreReleaseNumber }}"
-        echo "BuildMetaData: ${{ steps.gitversion.outputs.buildMetaData }}"
-        echo "BuildMetaDataPadded: ${{ steps.gitversion.outputs.buildMetaDataPadded }}"
-        echo "FullBuildMetaData: ${{ steps.gitversion.outputs.fullBuildMetaData }}"
-        echo "MajorMinorPatch: ${{ steps.gitversion.outputs.majorMinorPatch }}"
-        echo "SemVer: ${{ steps.gitversion.outputs.semVer }}"
-        echo "LegacySemVer: ${{ steps.gitversion.outputs.legacySemVer }}"
-        echo "LegacySemVerPadded: ${{ steps.gitversion.outputs.legacySemVerPadded }}"
-        echo "AssemblySemVer: ${{ steps.gitversion.outputs.assemblySemVer }}"
-        echo "AssemblySemFileVer: ${{ steps.gitversion.outputs.assemblySemFileVer }}"
-        echo "FullSemVer: ${{ steps.gitversion.outputs.fullSemVer }}"
-        echo "InformationalVersion: ${{ steps.gitversion.outputs.informationalVersion }}"
-        echo "BranchName: ${{ steps.gitversion.outputs.branchName }}"
-        echo "Sha: ${{ steps.gitversion.outputs.sha }}"
-        echo "ShortSha: ${{ steps.gitversion.outputs.shortSha }}"
-        echo "NuGetVersionV2: ${{ steps.gitversion.outputs.nuGetVersionV2 }}"
-        echo "NuGetVersion: ${{ steps.gitversion.outputs.nuGetVersion }}"
-        echo "NuGetPreReleaseTagV2: ${{ steps.gitversion.outputs.nuGetPreReleaseTagV2 }}"
-        echo "NuGetPreReleaseTag: ${{ steps.gitversion.outputs.nuGetPreReleaseTag }}"
-        echo "VersionSourceSha: ${{ steps.gitversion.outputs.versionSourceSha }}"
-        echo "CommitsSinceVersionSource: ${{ steps.gitversion.outputs.commitsSinceVersionSource }}"
-        echo "CommitsSinceVersionSourcePadded: ${{ steps.gitversion.outputs.commitsSinceVersionSourcePadded }}"
-        echo "CommitDate: ${{ steps.gitversion.outputs.commitDate }}"
-```
+## Setup GitVersion (gitversion/setup)
+
+- [Usage examples](setup/usage-examples.md)
+
+## Execute GitVersion (gitversion/execute)
+
+- [Usage examples](execute/usage-examples.md)

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

@@ -0,0 +1,89 @@
+# 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.7_ 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:
+
+```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
+ignoreFailedSources:
+  description: Treat package source failures as warnings.
+  required: false
+  default: false
+```
+
+---
+
+## Usage examples
+
+In order for the gitversion to properly work you need to clone the repository with the entire history:
+
+```yaml
+steps:
+  -
+    name: Checkout
+    uses: actions/checkout@v3
+    with:
+      fetch-depth: 0
+```
+
+### Example 1
+
+Install the latest GitVersion 5 version.
+
+```yaml
+steps:
+  - name: Install GitVersion
+    uses: gittools/actions/gitversion/setup@v0
+    with:
+      versionSpec: '5.x'
+```
+
+### Example 2
+
+Install GitVersion 5.5.0.
+
+```yaml
+steps:
+  - name: Install GitVersion
+    uses: gittools/actions/gitversion/setup@v0
+    with:
+      versionSpec: '5.5.0'
+```
+
+### Example 3
+
+Install the latest GitVersion 6 pre-release version.  For example **6.0.0-beta1.1**.
+
+```yaml
+steps:
+  - name: Install GitVersion
+    uses: gittools/actions/gitversion/setup@v0
+    with:
+      versionSpec: '6.x'
+      includePrerelease: true
+```
+
+### Example 4
+
+Install the latest GitVersion 5 version even it there is a cached version matching the versionSpec.
+
+```yaml
+steps:
+  - name: Install GitVersion
+    uses: gittools/actions/gitversion/setup@v0
+    with:
+      versionSpec: '5.x'
+      preferLatestVersion: true
+```

gitreleasemanager/addasset/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/addasset/bundle.js
 inputs:
   owner:

gitreleasemanager/close/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/close/bundle.js
 inputs:
   owner:

gitreleasemanager/create/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/create/bundle.js
 inputs:
   owner:

gitreleasemanager/discard/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/discard/bundle.js
 inputs:
   owner:

gitreleasemanager/open/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/open/bundle.js
 inputs:
   owner:

gitreleasemanager/publish/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/publish/bundle.js
 inputs:
   owner:

gitreleasemanager/setup/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitreleasemanager/setup/bundle.js
 inputs:
   versionSpec:
@@ -16,3 +16,11 @@ inputs:
     description: Include pre-release versions when matching a version
     required: false
     default: 'false'
+  ignoreFailedSources:
+    description: Treat package source failures as warnings.
+    required: false
+    default: 'false'
+  preferLatestVersion:
+    description: Prefer to download the latest version matching the versionSpec, even if there is a local cached version.
+    required: false
+    default: 'false'

gitversion/execute/action.yml

@@ -5,7 +5,7 @@ branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitversion/execute/bundle.js
 inputs:
   targetPath:
@@ -19,7 +19,7 @@ inputs:
   configFilePath:
     description: Optional path to config file (defaults to GitVersion.yml)
     required: false
-    default: ''
+    default: 'GitVersion.yml'
   updateAssemblyInfo:
     description: Whether to update versions in the AssemblyInfo files
     required: false
@@ -73,6 +73,8 @@ outputs:
     description: 'The InformationalVersion value'
   branchName:
     description: 'The BranchName value'
+  escapedBranchName:
+    description: 'The EscapedBranchName value'
   sha:
     description: 'The Sha value'
   shortSha:
@@ -91,5 +93,7 @@ outputs:
     description: 'The CommitsSinceVersionSource value'
   commitsSinceVersionSourcePadded:
     description: 'The CommitsSinceVersionSourcePadded value'
+  uncommittedChanges:
+    description: 'The UncommittedChanges value'
   commitDate:
-    description: 'The CommitDate value'
+    description: 'The CommitDate value'

gitversion/setup/action.yml

@@ -1,11 +1,11 @@
 name: gitversion-setup
-description: GitHub Action for Easy Semantic Versioning with GitVersion. Installs the specific version of GitVersion.Tool
+description: GitHub Action for Easy Semantic Versioning with GitVersion. Installs the specific version of GitVersion tool
 author: GitTools
 branding:
   color: gray-dark
   icon: git-pull-request
 runs:
-  using: node12
+  using: node20
   main: ../../dist/github/gitversion/setup/bundle.js
 inputs:
   versionSpec:
@@ -16,3 +16,11 @@ inputs:
     description: Include pre-release versions when matching a version
     required: false
     default: 'false'
+  ignoreFailedSources:
+    description: Treat package source failures as warnings.
+    required: false
+    default: 'false'
+  preferLatestVersion:
+    description: Prefer to download the latest version matching the versionSpec, even if there is a local cached version.
+    required: false
+    default: 'false'

package.json

@@ -1,7 +1,7 @@
 {
     "name": "gittools-actions",
     "version": "1.0.0",
-    "description": "Easy Semantic Versioning (http://semver.org) for projects using Git",
+    "description": "Easy Semantic Versioning (https://semver.org) for projects using Git",
     "repository": {
         "type": "git",
         "url": "https://github.com/GitTools/use-gitversion.git"
@@ -26,30 +26,34 @@
     ],
     "license": "MIT",
     "dependencies": {
-        "@actions/core": "^1.2.6",
-        "@actions/exec": "^1.0.4",
-        "@actions/io": "^1.0.2",
-        "@actions/tool-cache": "^1.6.0",
-        "azure-pipelines-task-lib": "^2.11.3",
-        "azure-pipelines-tool-lib": "^0.13.2",
-        "inversify": "^5.0.1",
-        "typed-rest-client": "^1.8.0",
-        "uuid": "^8.3.1"
+        "@actions/core": "^1.10.1",
+        "@actions/exec": "^1.1.1",
+        "@actions/io": "^1.1.3",
+        "@actions/tool-cache": "^2.0.1",
+        "azure-pipelines-tool-lib": "^2.0.7",
+        "inversify": "^6.0.2",
+        "semver": "^7.6.0",
+        "typed-rest-client": "^1.8.11",
+        "uuid": "^9.0.1"
     },
     "devDependencies": {
-        "@types/node": "^14.14.7",
-        "@types/q": "^1.5.4",
-        "@types/semver-compare": "^1.0.1",
-        "@types/uuid": "^8.3.0",
-        "minimist": "^1.2.5",
-        "prettier": "^2.1.2",
-        "reflect-metadata": "^0.1.13",
+        "@types/node": "^20.11.20",
+        "@types/q": "^1.5.8",
+        "@types/semver": "^7.5.8",
+        "@types/uuid": "^9.0.8",
+        "minimist": "^1.2.8",
+        "prettier": "^3.2.5",
+        "reflect-metadata": "^0.2.1",
         "replace-in-file-webpack-plugin": "^1.0.6",
-        "terser-webpack-plugin": "^5.0.3",
-        "tfx-cli": "^0.8.3",
-        "ts-loader": "^8.0.11",
-        "typescript": "^4.0.5",
-        "webpack": "^5.4.0",
-        "webpack-cli": "^4.2.0"
+        "shelljs": "^0.8.5",
+        "terser-webpack-plugin": "^5.3.10",
+        "tfx-cli": "^0.16.0",
+        "trim-newlines": ">=5.0.0",
+        "ts-loader": "^9.5.1",
+        "typescript": "^5.3.3",
+        "underscore": ">=1.13.6",
+        "validator": "^13.11.0",
+        "webpack": "^5.90.3",
+        "webpack-cli": "^5.1.4"
     }
 }

src/agent/azure/build-agent.ts

@@ -24,12 +24,7 @@ class BuildAgent implements IBuildAgent {
         return toolLib.findLocalTool(toolName, versionSpec, arch)
     }
 
-    public cacheDir(
-        sourceDir: string,
-        tool: string,
-        version: string,
-        arch?: string
-    ): Promise<string> {
+    public cacheDir(sourceDir: string, tool: string, version: string, arch?: string): Promise<string> {
         return toolLib.cacheDir(sourceDir, tool, version, arch)
     }
 
@@ -49,8 +44,8 @@ class BuildAgent implements IBuildAgent {
         taskLib.setResult(taskLib.TaskResult.Succeeded, message, done)
     }
 
-    public exportVariable(name: string, val: string): void {
-        taskLib.setVariable(name, val)
+    public setVariable(name: string, value: string): void {
+        taskLib.setVariable(name, value)
     }
 
     public getVariable(name: string): string {
@@ -83,7 +78,7 @@ class BuildAgent implements IBuildAgent {
     }
 
     public setOutput(name: string, value: string): void {
-        taskLib.setVariable(name, value)
+        taskLib.setVariable(name, value, false, true)
     }
 
     public getInput(input: string, required?: boolean): string {

src/agent/github/build-agent.ts

@@ -12,10 +12,7 @@ import * as toolCache from '@actions/tool-cache'
 import { injectable } from 'inversify'
 
 import { IBuildAgent, IExecResult } from '../../core/models'
-import {
-    IRequestOptions,
-    IProxyConfiguration
-} from 'typed-rest-client/Interfaces'
+import { IRequestOptions, IProxyConfiguration } from 'typed-rest-client/Interfaces'
 
 @injectable()
 class BuildAgent implements IBuildAgent {
@@ -58,12 +55,7 @@ class BuildAgent implements IBuildAgent {
             return undefined
         }
 
-        let proxyURL =
-            process.env.HTTP_PROXY ||
-            process.env.http_proxy ||
-            process.env.HTTPS_PROXY ||
-            process.env.https_proxy ||
-            null
+        let proxyURL = process.env.HTTP_PROXY || process.env.http_proxy || process.env.HTTPS_PROXY || process.env.https_proxy || null
 
         if (proxyURL) {
             let url = new urlApi.URL(requestedUrl)
@@ -78,12 +70,7 @@ class BuildAgent implements IBuildAgent {
         return undefined
     }
 
-    public cacheDir(
-        sourceDir: string,
-        tool: string,
-        version: string,
-        arch?: string
-    ): Promise<string> {
+    public cacheDir(sourceDir: string, tool: string, version: string, arch?: string): Promise<string> {
         return toolCache.cacheDir(sourceDir, tool, version, arch)
     }
 
@@ -123,7 +110,7 @@ class BuildAgent implements IBuildAgent {
         //
     }
 
-    public exportVariable(name: string, val: string): void {
+    public setVariable(name: string, val: string): void {
         core.exportVariable(name, val)
     }
 
@@ -141,24 +128,12 @@ class BuildAgent implements IBuildAgent {
 
     public async exec(exec: string, args: string[]): Promise<IExecResult> {
         const dotnetPath = await io.which(exec, true)
-        let resultCode = 0
-        let stdout = ''
-        let stderr = ''
-        resultCode = await exe.exec(`"${dotnetPath}"`, args, {
-            listeners: {
-                stderr: (data: Buffer) => {
-                    stderr += data.toString()
-                },
-                stdout: (data: Buffer) => {
-                    stdout += data.toString()
-                }
-            }
-        })
+        let result = await exe.getExecOutput(`"${dotnetPath}"`, args);
         return {
-            code: resultCode,
+            code: result.exitCode,
             error: null,
-            stderr,
-            stdout
+            stderr: result.stderr,
+            stdout: result.stdout
         }
     }
 
@@ -168,7 +143,6 @@ class BuildAgent implements IBuildAgent {
 
     public setOutput(name: string, value: string): void {
         core.setOutput(name, value)
-        core.exportVariable(`GITVERSION_${name.toUpperCase()}`, value)
     }
 
     public getInput(input: string, required?: boolean): string {

src/agent/mock/build-agent.ts

@@ -19,12 +19,7 @@ class BuildAgent implements IBuildAgent {
         return 'find'
     }
 
-    public cacheDir(
-        sourceDir: string,
-        tool: string,
-        version: string,
-        arch?: string
-    ): Promise<string> {
+    public cacheDir(sourceDir: string, tool: string, version: string, arch?: string): Promise<string> {
         console.log('cacheDir')
         return Promise.resolve('cacheDir')
     }
@@ -46,8 +41,8 @@ class BuildAgent implements IBuildAgent {
         console.log('setSucceeded')
     }
 
-    public exportVariable(name: string, val: string): void {
-        console.log('exportVariable')
+    public setVariable(name: string, val: string): void {
+        console.log('setVariable')
     }
 
     public getVariable(name: string): string {

src/core/dotnet-tool.ts

@@ -4,17 +4,13 @@ import * as path from 'path'
 import * as http from 'typed-rest-client/HttpClient'
 
 import { inject, injectable } from 'inversify'
-import { TYPES, IExecResult, IBuildAgent } from './models'
+import { IBuildAgent, IExecResult, TYPES } from './models'
 import { IVersionManager } from './versionManager'
+import { ISetupSettings } from '../tools/common/models'
 
 export interface IDotnetTool {
     disableTelemetry(): void
-    toolInstall(
-        toolName: string,
-        versionSpec: string,
-        checkLatest: boolean,
-        includePre: boolean
-    ): Promise<string>
+    toolInstall(toolName: string, setupSettings: ISetupSettings): Promise<string>
 }
 
 @injectable()
@@ -23,24 +19,17 @@ export class DotnetTool implements IDotnetTool {
     protected versionManager: IVersionManager
     private httpClient: http.HttpClient
 
-    private static readonly nugetRoot: string =
-        'https://api-v2v3search-0.nuget.org/'
+    private static readonly nugetRoot: string = 'https://azuresearch-usnc.nuget.org/query'
 
-    constructor(
-        @inject(TYPES.IBuildAgent) buildAgent: IBuildAgent,
-        @inject(TYPES.IVersionManager) versionManager: IVersionManager
-    ) {
+    constructor(@inject(TYPES.IBuildAgent) buildAgent: IBuildAgent, @inject(TYPES.IVersionManager) versionManager: IVersionManager) {
         this.buildAgent = buildAgent
         this.versionManager = versionManager
-        this.httpClient = new http.HttpClient(
-            'dotnet',
-            undefined,
-            this.buildAgent.proxyConfiguration(DotnetTool.nugetRoot)
-        )
+        this.httpClient = new http.HttpClient('dotnet', undefined, this.buildAgent.proxyConfiguration(DotnetTool.nugetRoot))
     }
 
     public disableTelemetry(): void {
-        this.buildAgent.exportVariable('DOTNET_CLI_TELEMETRY_OPTOUT', '1')
+        this.buildAgent.setVariable('DOTNET_CLI_TELEMETRY_OPTOUT', 'true')
+        this.buildAgent.setVariable('DOTNET_NOLOGO', 'true')
     }
 
     public execute(cmd: string, args: string[]): Promise<IExecResult> {
@@ -48,19 +37,17 @@ export class DotnetTool implements IDotnetTool {
         return this.buildAgent.exec(cmd, args)
     }
 
-    public async toolInstall(
-        toolName: string,
-        versionSpec: string,
-        checkLatest: boolean,
-        includePre: boolean
-    ): Promise<string> {
+    public async toolInstall(toolName: string, setupSettings: ISetupSettings): Promise<string> {
         console.log('')
         console.log('--------------------------')
-        console.log(`Installing ${toolName} version ` + versionSpec)
+        console.log(`Acquiring ${toolName} version spec: ${setupSettings.versionSpec}`)
         console.log('--------------------------')
 
-        if (this.versionManager.isExplicitVersion(versionSpec)) {
+        let version: string
+        let checkLatest = setupSettings.preferLatestVersion
+        if (this.versionManager.isExplicitVersion(setupSettings.versionSpec)) {
             checkLatest = false // check latest doesn't make sense when explicit version
+            version = setupSettings.versionSpec
         }
 
         let toolPath: string
@@ -68,16 +55,15 @@ export class DotnetTool implements IDotnetTool {
             //
             // Let's try and resolve the version spec locally first
             //
-            toolPath = this.buildAgent.find(toolName, versionSpec)
+            toolPath = this.buildAgent.find(toolName, setupSettings.versionSpec)
         }
 
         if (!toolPath) {
-            let version: string
-            if (this.versionManager.isExplicitVersion(versionSpec)) {
+            if (this.versionManager.isExplicitVersion(setupSettings.versionSpec)) {
                 //
                 // Explicit version was specified. No need to query for list of versions.
                 //
-                version = versionSpec
+                version = setupSettings.versionSpec
             } else {
                 //
                 // Let's query and resolve the latest version for the versionSpec.
@@ -85,15 +71,9 @@ export class DotnetTool implements IDotnetTool {
                 // If your tool doesn't offer a mechanism to query,
                 // then it can only support exact version inputs.
                 //
-                version = await this.queryLatestMatch(
-                    toolName,
-                    versionSpec,
-                    includePre
-                )
+                version = await this.queryLatestMatch(toolName, setupSettings.versionSpec, setupSettings.includePrerelease)
                 if (!version) {
-                    throw new Error(
-                        `Unable to find ${toolName} version '${versionSpec}'.`
-                    )
+                    throw new Error(`Unable to find ${toolName} version '${setupSettings.versionSpec}'.`)
                 }
 
                 //
@@ -105,46 +85,38 @@ export class DotnetTool implements IDotnetTool {
                 //
                 // Download, extract, cache
                 //
-                toolPath = await this.acquireTool(toolName, version)
+                toolPath = await this.acquireTool(toolName, version, setupSettings.ignoreFailedSources)
             }
         }
 
+        console.log('--------------------------')
+        console.log(`${toolName} version: ${version} installed.`)
+        console.log('--------------------------')
         //
         // Prepend the tools path. This prepends the PATH for the current process and
         // instructs the agent to prepend for each task that follows.
         //
         this.buildAgent.debug(`toolPath: ${toolPath}`)
 
-        if (
-            os.platform() !== 'win32' &&
-            !this.buildAgent.getVariable('DOTNET_ROOT')
-        ) {
+        if (os.platform() !== 'win32' && !this.buildAgent.getVariable('DOTNET_ROOT')) {
             let dotnetPath = await this.buildAgent.which('dotnet')
             dotnetPath = fs.readlinkSync(dotnetPath) || dotnetPath
             const dotnetRoot = path.dirname(dotnetPath)
-            this.buildAgent.exportVariable('DOTNET_ROOT', dotnetRoot)
+            this.buildAgent.setVariable('DOTNET_ROOT', dotnetRoot)
         }
         this.buildAgent.addPath(toolPath)
 
         return toolPath
     }
 
-    private async queryLatestMatch(
-        toolName: string,
-        versionSpec: string,
-        includePrerelease: boolean
-    ): Promise<string> {
+    private async queryLatestMatch(toolName: string, versionSpec: string, includePrerelease: boolean): Promise<string> {
         this.buildAgent.debug(
-            `querying tool versions for ${toolName}${
-                versionSpec ? `@${versionSpec}` : ''
-            } ${includePrerelease ? 'including pre-releases' : ''}`
+            `querying tool versions for ${toolName}${versionSpec ? `@${versionSpec}` : ''} ${includePrerelease ? 'including pre-releases' : ''}`
         )
 
-        const downloadPath = `${
-            DotnetTool.nugetRoot
-        }query?q=${encodeURIComponent(toolName.toLowerCase())}&prerelease=${
-            includePrerelease ? 'true' : 'false'
-        }&semVerLevel=2.0.0`
+        const toolNameParam = encodeURIComponent(toolName.toLowerCase())
+        const prereleaseParam = includePrerelease ? 'true' : 'false'
+        const downloadPath = `${DotnetTool.nugetRoot}?q=${toolNameParam}&prerelease=${prereleaseParam}&semVerLevel=2.0.0&take=1`
 
         const res = await this.httpClient.get(downloadPath)
 
@@ -155,25 +127,26 @@ export class DotnetTool implements IDotnetTool {
         const body: string = await res.readBody()
         const data = JSON.parse(body).data
 
-        const versions = (data[0].versions as { version: string }[]).map(
-            x => x.version
-        )
+        const versions = (data[0].versions as { version: string }[]).map(x => x.version)
         if (!versions || !versions.length) {
             return null
         }
 
         this.buildAgent.debug(`got versions: ${versions.join(', ')}`)
 
-        return this.versionManager.evaluateVersions(versions, versionSpec)
+        return this.versionManager.evaluateVersions(versions, versionSpec, {
+            includePrerelease
+        })
     }
 
-    private async acquireTool(
-        toolName: string,
-        version: string
-    ): Promise<string> {
+    private async acquireTool(toolName: string, version: string, ignoreFailedSources: boolean): Promise<string> {
         const tempDirectory = await this.buildAgent.createTempDir()
         let args = ['tool', 'install', toolName, '--tool-path', tempDirectory]
 
+        if (ignoreFailedSources) {
+            args.push('--ignore-failed-sources')
+        }
+
         if (version) {
             version = this.versionManager.cleanVersion(version)
             args = args.concat(['--version', version])

src/core/models.ts

@@ -5,17 +5,9 @@ export const TYPES = {
     IDotnetTool: Symbol.for('DotnetTool'),
     IGitVersionTool: Symbol.for('GitVersionTool'),
     IGitReleaseManagerTool: Symbol.for('GitReleaseManagerTool'),
-    IVersionManager: Symbol.for('VersionManager')
-}
-
-export enum SetupFields {
-    includePrerelease = 'includePrerelease',
-    versionSpec = 'versionSpec'
-}
-
-export interface ISetupSettings {
-    [SetupFields.versionSpec]: string
-    [SetupFields.includePrerelease]: boolean
+    IVersionManager: Symbol.for('VersionManager'),
+    IGitVersionSettingsProvider: Symbol.for('GitVersionSettingsProvider'),
+    IGitReleaseManagerSettingsProvider: Symbol.for('GitReleaseManagerSettingsProvider')
 }
 
 export interface IExecResult {
@@ -24,22 +16,16 @@ export interface IExecResult {
     code: number
     error: Error
 }
-
 export interface IBuildAgent {
     agentName: string
     proxyConfiguration(url: string): IRequestOptions
     find(toolName: string, versionSpec: string, arch?: string): string
-    cacheDir(
-        sourceDir: string,
-        tool: string,
-        version: string,
-        arch?: string
-    ): Promise<string>
+    cacheDir(sourceDir: string, tool: string, version: string, arch?: string): Promise<string>
     createTempDir(): Promise<string>
     debug(message: string): void
     setFailed(message: string, done?: boolean): void
     setSucceeded(message: string, done?: boolean): void
-    exportVariable(name: string, val: string): void
+    setVariable(name: string, val: string): void
     getVariable(name: string): string
     addPath(inputPath: string): void
     which(tool: string, check?: boolean): Promise<string>

src/core/settings.ts

@@ -1,15 +0,0 @@
-import { IBuildAgent, SetupFields, ISetupSettings } from './models'
-
-export class Settings {
-    public static getSetupSettings(buildAgent: IBuildAgent): ISetupSettings {
-        const versionSpec = buildAgent.getInput(SetupFields.versionSpec)
-        const includePrerelease = buildAgent.getBooleanInput(
-            SetupFields.includePrerelease
-        )
-
-        return {
-            versionSpec,
-            includePrerelease
-        }
-    }
-}

src/core/versionManager.ts

@@ -1,4 +1,3 @@
-import cmp from 'semver-compare'
 import * as semver from 'semver'
 import { injectable, inject } from 'inversify'
 
@@ -6,7 +5,7 @@ import { IBuildAgent, TYPES } from './models'
 
 export interface IVersionManager {
     isExplicitVersion(versionSpec: string): boolean
-    evaluateVersions(versions: string[], versionSpec: string): string
+    evaluateVersions(versions: string[], versionSpec: string, optionsOrLoose?: boolean | semver.RangeOptions): string
     cleanVersion(version: string): string
 }
 
@@ -27,13 +26,13 @@ export class VersionManager implements IVersionManager {
         return valid
     }
 
-    public evaluateVersions(versions: string[], versionSpec: string): string {
+    public evaluateVersions(versions: string[], versionSpec: string, optionsOrLoose?: boolean | semver.RangeOptions): string {
         let version: string
         this.buildAgent.debug('evaluating ' + versions.length + ' versions')
-        versions = versions.sort(cmp)
+        versions = semver.sort(versions)
         for (let i = versions.length - 1; i >= 0; i--) {
             const potential: string = versions[i]
-            const satisfied: boolean = semver.satisfies(potential, versionSpec)
+            const satisfied: boolean = semver.satisfies(potential, versionSpec, optionsOrLoose)
             if (satisfied) {
                 version = potential
                 break

src/tasks/gitreleasemanager/addasset.ts

@@ -1,4 +1,4 @@
 import 'reflect-metadata'
 import { addAsset } from './main'
 
-addAsset()
+await addAsset()

src/tasks/gitreleasemanager/close.ts

@@ -1,4 +1,4 @@
 import 'reflect-metadata'
 import { close } from './main'
 
-close()
+await close()

src/tasks/gitreleasemanager/create.ts

@@ -1,4 +1,4 @@
 import 'reflect-metadata'
 import { create } from './main'
 
-create()
+await create()

src/tasks/gitreleasemanager/discard.ts

@@ -1,4 +1,4 @@
 import 'reflect-metadata'
 import { discard } from './main'
 
-discard()
+await discard()

src/tasks/gitreleasemanager/main.ts

@@ -1,37 +1,26 @@
 import { IBuildAgent, TYPES } from '../../core/models'
-import {
-    IGitReleaseManagerTool,
-    GitReleaseManagerTool
-} from '../../tools/gitreleasemanager/tool'
-import { Settings as CommonSettings } from '../../core/settings'
-import { Settings } from '../../tools/gitreleasemanager/settings'
+import { IGitReleaseManagerTool, GitReleaseManagerTool } from '../../tools/gitreleasemanager/tool'
+import { IGitReleaseManagerSettingsProvider } from '../../tools/gitreleasemanager/models'
+import { GitReleaseManagerSettingsProvider } from '../../tools/gitreleasemanager/settings'
 
 import container from '../../core/ioc'
 
-container
-    .bind<IGitReleaseManagerTool>(TYPES.IGitReleaseManagerTool)
-    .to(GitReleaseManagerTool)
+container.bind<IGitReleaseManagerTool>(TYPES.IGitReleaseManagerTool).to(GitReleaseManagerTool)
+container.bind<IGitReleaseManagerSettingsProvider>(TYPES.IGitReleaseManagerSettingsProvider).to(GitReleaseManagerSettingsProvider)
 
-const gitReleaseManagerTool = container.get<IGitReleaseManagerTool>(
-    TYPES.IGitReleaseManagerTool
-)
 const buildAgent = container.get<IBuildAgent>(TYPES.IBuildAgent)
+const gitReleaseManagerTool = container.get<IGitReleaseManagerTool>(TYPES.IGitReleaseManagerTool)
+const settingsProvider = container.get<IGitReleaseManagerSettingsProvider>(TYPES.IGitReleaseManagerSettingsProvider)
 
 export async function setup() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = CommonSettings.getSetupSettings(buildAgent)
+        const settings = settingsProvider.getSetupSettings()
 
-        await gitReleaseManagerTool.install(
-            settings.versionSpec,
-            settings.includePrerelease
-        )
+        await gitReleaseManagerTool.install(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager installed successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager installed successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }
@@ -41,14 +30,11 @@ export async function create() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = Settings.getCreateSettings(buildAgent)
+        const settings = settingsProvider.getCreateSettings()
 
         await gitReleaseManagerTool.create(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager created release successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager created release successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }
@@ -58,14 +44,11 @@ export async function discard() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = Settings.getDiscardSettings(buildAgent)
+        const settings = settingsProvider.getDiscardSettings()
 
         await gitReleaseManagerTool.discard(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager discarded release successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager discarded release successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }
@@ -75,14 +58,11 @@ export async function close() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = Settings.getCloseSettings(buildAgent)
+        const settings = settingsProvider.getCloseSettings()
 
         await gitReleaseManagerTool.close(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager closed release successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager closed release successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }
@@ -92,14 +72,11 @@ export async function open() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = Settings.getOpenSettings(buildAgent)
+        const settings = settingsProvider.getOpenSettings()
 
         await gitReleaseManagerTool.open(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager opened release successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager opened release successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }
@@ -109,14 +86,11 @@ export async function publish() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = Settings.getPublishSettings(buildAgent)
+        const settings = settingsProvider.getPublishSettings()
 
         await gitReleaseManagerTool.publish(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager published release successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager published release successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }
@@ -126,14 +100,11 @@ export async function addAsset() {
     try {
         gitReleaseManagerTool.disableTelemetry()
 
-        const settings = Settings.getAddAssetSettings(buildAgent)
+        const settings = settingsProvider.getAddAssetSettings()
 
         await gitReleaseManagerTool.addAsset(settings)
 
-        buildAgent.setSucceeded(
-            'GitVersionManager added assets to release successfully',
-            true
-        )
+        buildAgent.setSucceeded('GitVersionManager added assets to release successfully', true)
     } catch (error) {
         buildAgent.setFailed(error.message, true)
     }

src/tasks/gitreleasemanager/open.ts

@@ -1,4 +1,4 @@
 import 'reflect-metadata'
 import { open } from './main'
 
-open()
+await open()

src/tasks/gitreleasemanager/publish.ts

@@ -1,4 +1,4 @@
 import 'reflect-metadata'
 import { publish } from './main'
 
-publish()
+await publish()