semantic-release-ado

Semantic release plugin for automatic builds on Azure DevOps pipelines.

Step	Description
analyzeCommits	If configured to do so, stores the current version as an Azure DevOps pipeline variable.
verifyRelease	Stores the next version as an Azure DevOps pipeline variable availabe to downstream steps on the job.

Install

1$ npm install -D semantic-release-ado

Usage

The plugin can be configured in the semantic-release configuration file:

YAML:

1plugins:
2  - @semantic-release-ado"

JSON:

1{
2  "plugins": [
3    "semantic-release-ado",
4  ]
5}

The generated version number will be stored on a variable availabe to downstream steps on the job. By default this variable is named nextRelease, but the name can be configured in the plugin options. The behavior when no new release is available can be configured with setOnlyOnRelease.

Configuration

Options

Options	Desctiption
varName	Name of the variable that will store the next version. Defaults to nextRelease.
setOnlyOnRelease	Bool. Determines if the variable with the new version will be set only when a new version is available. If set to false, the next version variable will store the last released version when no new version is available. Defaults to true.
isOutput	Bool. Determines whether the version will be set as an output variable, so it is available in later stages. Defaults to false.

The following examples store the generated version number in a variable named version.

YAML:

1plugins:
2  - - "semantic-release-ado"
3    - varName: "version"
4      setOnlyOnRelease: true
5      isOutput: true #defaults to false

JSON:

1{
2  "plugins": [
3    ["semantic-release-ado", {
4      "varName": "version",
5      "setOnlyOnRelease": true,
6      "isOutput": true //defaults to false
7    }],
8  ]
9}

Azure DevOps build pipeline YAML example:

Using the variable on the seme job:

1jobs:
2- job: Build
3  pool:
4    vmImage: 'vs2017-win2016'
5  steps:
6
7  - script: >
8      npx -p semantic-release
9      -p @semantic-release/git
10      -p semantic-release-ado
11      semantic-release
12    env: { GH_TOKEN: $(GitHubToken) }
13    displayName: 'Semantic release'
14
15  - script: echo $(nextRelease)
16    displayName: 'Show next version'

Using the variable on a later job:

Configuration:

Below is the configuration for setting isOutput to true, which will allow the variable to be referenced from other jobs/stages

JSON:

1{
2  "plugins": [
3    ["semantic-release-ado", {
4      "varName": "version",
5      "setOnlyOnRelease": true,
6      "isOutput": true //sets version as output for later use
7    }],
8  ]
9}

In another job:

1jobs:
2- job: Job1
3  pool:
4    vmImage: 'vs2017-win2016'
5
6  steps:
7  - script: >
8      npx -p semantic-release
9      -p @semantic-release/git
10      -p semantic-release-ado
11      semantic-release
12    env: { GH_TOKEN: $(GitHubToken) }
13    displayName: 'Semantic release'
14
15- job: Job2
16  dependsOn: Job1
17  pool:
18    vmImage: 'vs2017-win2016'
19  variables:
20    versionNumber: $[ dependencies.Job1.outputs['setOutputVar.versionNumber'] ]
21
22  steps:
23  - script: echo $(versionNumber)
24    displayName: 'Show next version'

In another stage:

1stages: 
2  - stage: Stage1
3    jobs:
4    - job: Job1
5      pool:
6        vmImage: 'vs2017-win2016'
7
8      steps:
9      - script: >
10          npx -p semantic-release
11          -p @semantic-release/git
12          -p semantic-release-ado
13          semantic-release
14        env: { GH_TOKEN: $(GitHubToken) }
15        name: semantic-release
16        displayName: 'Semantic release'
17
18  - stage: Stage2
19    dependsOn: Stage1
20    #want to make sure variable is set before we continue to run the stage
21    condition: and(succeeded(), ne(dependencies.Stage1.outputs['Job1.semantic-release.version'], ''))
22    jobs:
23    - job: Job2
24      variables:
25          versionNumber: $[ stageDependencies.Stage1.Job1.outputs['semantic-release.version'] ]
26      pool:
27        vmImage: 'vs2017-win2016'
28      variables:
29        versionNumber:
30      steps:
31      - script: echo $(versionNumber)
32        displayName: 'Show next version'