Tasks

• Extract SemVer task
• UZG Nuget Versioning task

UZG Nuget Versioning task

Sets nuget version based on semantic versioning in SourceBranchName.

YAML snippet

#UZG Nuget Versioning
- task: UZGVersioning@0

Task Inputs

None

Remarks

This task will attempt to parse a Semver (optionally prefixed with "v" or "V") from the Build.SourceBranchName.
On success:

• sets $(versioningScheme) = "byEnvVar"
• sets $(versioningPackageVersion) = the parsed semver
• updates the BuildNumber to "$(Build.DefinitionName) - $(semver)"

On failure:

• logs a warning
• sets $(versioningScheme) = "byBuildNumber"
• sets $(versioningPackageVersion) = $(Build.BuildNumber)

Examples

For more information about versioning schemes see the NuGet task documentation.

For more information about BuildNumber (set by the pipeline "name" property) requirements when using "byBuildNumber", see the Nuget task documentation on the "versioningScheme"-argument

DotNetCoreCLI pack

name: $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)
#buildname containing a semver when UZGVersioning fails to parse $(Build.SourceBranchName) and will use versioningScheme = "byBuildNumber"

steps:

#UZG Nuget Versioning
- task: UZGVersioning@0
  displayName: 'UZG Nuget Versioning'

#Pack a NuGetPackage with DotNetCoreCLI
- task: DotNetCoreCLI@2
  displayName: Pack
  inputs:
    command: 'pack'
    packagesToPack: '**/*.csproj'
    # Use the variable set in the UZGVersioning task ("byEnvVar" or "byBuildNumber")
    versioningScheme: $(versioningScheme)
    # for "byEnvVar" provide the name of the variable to use
    versionEnvVar: 'versioningPackageVersion'   

NuGetCommand pack

Using the UZGVersioning with the NuGetCommand task works exactly the same.

...
- task: UZGVersioning@0

- task: NuGetCommand@2
  inputs:
    command: 'pack'
    packagesToPack: '**/*.csproj'
    versioningScheme: $(versioningScheme)
    versionEnvVar: 'versioningPackageVersion'   
...

Input/Output examples:

Extract SemVer task

Extract a Semantic version (semver) from a given input.

YAML snippet

#Extract Semantic Version.
- task: ExtractSemver@0
  inputs:
    #input: $(Build.SourceBranchName) # Optional
    #inputFormat: '^[Vv]?{semver}$' # Optional
    #outputFormat: '{major}.{minor}.{patch}{prerelease}' # Optional
    #inputIgnorePrefixZero: true #Optional

Task Inputs

Task Output Variables

Examples

PowerShell Write-Host

1. Extract semver from the exampleInput-variable
2. Display the resulting output variables (with PowerShell Write-Host).

variables:
  exampleInput: 'v1.2.3-preview42'

steps:
  # Extract semver from $(exampleInput)
  - task: ExtractSemver@0
    name: GetSemver
    inputs:
      input: '$(exampleInput)'
      
  # Output the result 
  - powershell: |
        Write-Host "isValid: $(GetSemver.isValid)"
        Write-Host "match: $(GetSemver.match)"
        Write-Host "formatted: $(GetSemver.formatted)"
        Write-Host "major: $(GetSemver.major)"
        Write-Host "minor: $(GetSemver.minor)"
        Write-Host "patch: $(GetSemver.patch)"
        Write-Host "prerelease: $(GetSemver.prerelease)"
        Write-Host "buildmetadata: $(GetSemver.buildmetadata)"

The powershell task output:

isValid: True
match: 1.2.3-preview42
formatted: 1.2.3-preview42
major: 1
minor: 2
patch: 3
prerelease: preview42
buildmetadata: 

DotNetCoreCLI Pack

1. Extract semver from the exampleInput-variable
2. Choose version control scheme depending on the GetSemver.isValid variable
3. Use the versioningScheme and versioningPackageVersion variables with DotNetCoreCLI "pack".

name: $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)

variables:
  exampleInput: 'v1.2.3-preview42'

steps:
# Extract semver from $(exampleInput)
- task: ExtractSemver@0
  name: GetSemver
  inputs:
    input: '$(exampleInput)'

# decide the 'versioningScheme'. If semver isValid; use versioningScheme="byEnvVar" otherwise, use "byBuildNumber"
- powershell: |
      if ("$(GetSemver.isValid)" -eq $true) {
        Write-Host "##vso[task.setvariable variable=versioningScheme]byEnvVar"
        Write-Host "##vso[task.setvariable variable=versioningPackageVersion]$(GetSemver.formatted)"
      } else {
        Write-Host "##vso[task.setvariable variable=versioningScheme]byBuildNumber"
      }
 
- task: DotNetCoreCLI@2
  displayName: Pack
  inputs:
    command: 'pack'
    packagesToPack: '**/*.csproj'
    # Use the variable set in the UZGVersioning task ("byEnvVar" or "byBuildNumber")    
    versioningScheme: "$(versioningScheme)"
    # for "byEnvVar" provide the name of the variable to use
    versionEnvVar: 'versioningPackageVersion'

npm-version

1. Extract semver from the exampleInput-variable
2. Update package.json if the semver isValid

name: $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)

variables:
  exampleInput: 'v1.2.3-preview42'

steps:
- task: ExtractSemver@0
  name: PackageVersion
  inputs:
    input: '$(exampleInput)'

- task: Npm@1
  condition: and(succeeded(), eq(variables['PackageVersion.isValid'], 'True'))
  inputs:
    command: 'custom'
    customCommand: 'version $(PackageVersion.formatted) --no-git-tag-version --allow-same-version'

Input/Output examples:

Using the default inputFormat and outputFormat, given input:

(*) the default outputFormat doesn't output {buildmetadata}) (**) assuming inputIgnorePrefixZero is (the default value); true