Azure DevOps Pipelines

https://learn.microsoft.com/en-us/azure/devops/pipelines
Admin
Azure Pipelines enables continuous integration and continuous delivery (CI/CD) for various...
Tokens:1,378,361
Snippets:12,046
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and start Docker Desktop

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/ecosystems/containers/publish-to-acr

Installs and starts Docker Desktop. Run this from the download path after downloading the installer.

```powershell
Start-Process 'Docker%20Desktop%20Installer.exe' -Wait install

```

--------------------------------

### CmdLine@2 examples

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/cmd-line-v2

Example steps using the script shortcut to get the date, list directory contents, and set and display environment variables.

```yaml
steps:
- script: date /t
  displayName: Get the date
- script: dir
  workingDirectory: $(Agent.BuildDirectory)
  displayName: List contents of a folder
- script: |
    set MYVAR=foo
    set
  displayName: Set a variable and then display all
  env:
    aVarFromYaml: someValue

```

--------------------------------

### Example pipeline using Go@0

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/go-v0

Example pipeline that uses GoTool@0 to install Go 1.10, then Go@0 to run 'go get' and 'go build', archives the build output, and publishes it as an artifact. The variables define Go paths and the module path.

```yaml
variables:
  GOBIN:  '$(GOPATH)/bin' # Go binaries path
  GOROOT: '/usr/local/go1.11' # Go installation path
  GOPATH: '$(system.defaultWorkingDirectory)/gopath' # Go workspace path
  modulePath: '$(GOPATH)/src/github.com/$(build.repository.name)' # Path to the module's code

steps:
- task: GoTool@0
  displayName: 'Use Go 1.10'

- task: Go@0
  displayName: 'go get'
  inputs:
    arguments: '-d'

- task: Go@0
  displayName: 'go build'
  inputs:
    command: build
    arguments: '-o "$(System.TeamProject).exe"'

- task: ArchiveFiles@2
  displayName: 'Archive files'
  inputs:
    rootFolderOrFile: '$(Build.Repository.LocalPath)'
    includeRootFolder: False

- task: PublishBuildArtifacts@1
  displayName: 'Publish artifact'
  condition: succeededOrFailed()

```

--------------------------------

### Install agent service with ./svc.sh install

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/osx-agent

Creates a launchd plist that points to ./runsvc.sh, which sets up the environment and starts the agent's host.

```bash
./svc.sh install

```

--------------------------------

### HelmDeploy install command example

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/helm-deploy-v0

Use this YAML example to run the 'install' helm command with a chart from a file path. It sets chartType to 'FilePath' and specifies the chartPath.

```YAML
- task: HelmDeploy@0
  displayName: Helm install
  inputs:
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureResourceGroup: $(azureResourceGroup)
    kubernetesCluster: $(kubernetesCluster)
    command: install
    chartType: FilePath
    chartPath: Application/charts/sampleapp

```

--------------------------------

### Travis CI phases example (.travis.yml)

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/migrate/from-travis

Shows Travis CI's fixed named phases (before_install, install, script) for installing dependencies and running build and tests.

```yaml
before_install:
    - npm install -g bower
install:
    - npm install
    - bower install
script:
    - npm run build
    - npm test

```

--------------------------------

### Full pipeline example for Windows

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/artifacts/cargo-pipelines

A complete YAML pipeline example for Windows agents that installs Rustup, authenticates with CargoAuthenticate, builds the project, and publishes to a feed.

```yaml
trigger:
- main

pool:
  vmImage: windows-latest

steps:
- powershell: |
   Invoke-WebRequest -Uri https://sh.rustup.rs -OutFile rustup-init.sh
   bash .\rustup-init.sh -y
   echo "##vso[task.prependpath]$env:USERPROFILE\.cargo\bin"
  displayName: Install

- task: CargoAuthenticate@0
  displayName: 'cargo Authenticate'
  inputs:
    configFile: '.cargo/config.toml'

- script: |
   cargo build --all
  displayName: Build

- powershell: |
   cargo publish --registry CargoInternalFeed
  displayName: Publish
```

--------------------------------

### Example: full environment syntax

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/jobs-deployment-environment

Full syntax example with comments explaining each property and a runOnce deployment strategy.

```yaml
environment:            # create environment and/or record deployments
  name: string          # name of the environment to run this job on.
  resourceName: string  # name of the resource in the environment to record the deployments against
  resourceId: number    # resource identifier
  resourceType: string  # type of the resource you want to target. Supported types - virtualMachine, Kubernetes
  tags: string          # comma separated tag names to filter the resources in the environment
strategy:               # deployment strategy
  runOnce:              # default strategy
    deploy:
      steps:
      - script: echo Hello world

```

--------------------------------

### Full Dockerfile example for nonglibc-based containers

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/process/container-phases

Complete Dockerfile for a nonglibc-based container (Alpine) that supplies its own Node.js, installs required packages, and sets the handler node path label. Use this as a starting point for pipelines that run on Alpine-based images.

```Dockerfile
FROM node:18-alpine

RUN apk add --no-cache --virtual .pipeline-deps readline linux-pam \
  && apk add bash sudo shadow \
  && apk del .pipeline-deps

LABEL "com.azure.dev.pipelines.agent.handler.node.path"="/usr/local/bin/node"

CMD [ "node" ]

```

--------------------------------

### Startup command examples

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/deploy/azure-rm-web-app-deployment

Startup command examples for Azure App Service. Use when appType is set to webAppLinux, webAppContainer, functionAppContainer, functionAppLinux, or webAppHyperVContainer.

```shell
dotnet exec `filename.dll`
```

```shell
dotnet `filename.dll`.
```

--------------------------------

### Install Go dependencies with go get

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/ecosystems/go

Use `go get` to download the source code for a Go project or to install a tool into the Go workspace. Add this snippet to your `azure-pipelines.yml` file.

```yaml
- script: go get -v -t -d ./...
  workingDirectory: '$(modulePath)'
  displayName: 'go get dependencies'

```

--------------------------------

### Startup command example (dotnet exec)

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/azure-rm-web-app-deployment-v4

Startup command examples for Azure App Service tasks. Use the first when a specific executable is required; use the second as a shorter alternative. Both run the .NET DLL as the startup command.

```bash
dotnet exec `filename.dll`
```

```bash
dotnet `filename.dll`
```

--------------------------------

### Startup command examples for Linux function apps

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/deploy/azure-function-app

Examples of startup commands for Linux function apps, such as 'dotnet run' and 'dotnet filename.dll'.

```bash
dotnet run
```

```bash
dotnet filename.dll
```

--------------------------------

### Azure App Service manage v0 YAML task definition

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/azure-app-service-manage-v0

YAML pipeline task definition for Azure App Service manage v0. Use to start, stop, restart, swap slots, delete slots, install site extensions, or enable continuous monitoring. The Action input defaults to 'Swap Slots'; other actions include 'Start Azure App Service', 'Stop Azure App Service', 'Restart Azure App Service', 'Start Swap With Preview', 'Complete Swap', 'Cancel Swap', 'Delete Slot', 'Install Extensions', 'Enable Continuous Monitoring', 'Start all continuous webjobs', and 'Stop all continuous webjobs'. Required inputs vary by action; for example, ResourceGroupName is required when Action is Swap Slots, Delete Slot, Start Swap With Preview, Complete Swap, or Cancel Swap, or when SpecifySlotOrASE is true.

```yaml
# Azure App Service manage v0
# Start, stop, restart, slot swap, slot delete, install site extensions or enable continuous monitoring for an Azure App Service.
- task: AzureAppServiceManage@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    #Action: 'Swap Slots' # 'Swap Slots' | 'Start Azure App Service' | 'Stop Azure App Service' | 'Restart Azure App Service' | 'Start Swap With Preview' | 'Complete Swap' | 'Cancel Swap' | 'Delete Slot' | 'Install Extensions' | 'Enable Continuous Monitoring' | 'Start all continuous webjobs' | 'Stop all continuous webjobs'. Action. Default: Swap Slots.
    WebAppName: # string. Required. App Service name. 
    #SpecifySlotOrASE: false # boolean. Alias: SpecifySlot. Optional. Use when Action != Swap Slots && Action != Delete Slot && Action != Start Swap With Preview && Action != Complete Swap && Action != Cancel Swap. Specify Slot or App Service Environment. Default: false.
    #ResourceGroupName: # string. Required when Action = Swap Slots || Action = Delete Slot || SpecifySlotOrASE = true || Action = Start Swap With Preview || Action = Complete Swap || Action = Cancel Swap. Resource group. 
    #SourceSlot: # string. Required when Action = Swap Slots || Action = Start Swap With Preview  || Action = Complete Swap. Source Slot. 
    #SwapWithProduction: true # boolean. Optional. Use when Action = Swap Slots || Action = Start Swap With Preview  || Action = Complete Swap. Swap with Production. Default: true.
    #TargetSlot: # string. Required when SwapWithProduction = false. Target Slot. 
    #PreserveVnet: false # boolean. Optional. Use when Action = Swap Slots || Action = Start Swap With Preview || Action = Complete Swap. Preserve Vnet. Default: false.
    #Slot: 'production' # string. Required when Action = Delete Slot || Action = Cancel Swap || SpecifySlotOrASE = true. Slot. Default: production.
    #ExtensionsList: # string. Required when Action = Install Extensions. Install Extensions. 
    #OutputVariable: # string. Optional. Use when Action = Install Extensions. Output variable. 
    #AppInsightsResourceGroupName: # string. Required when Action == Enable Continuous Monitoring. Resource Group name for Application Insights. 
    #ApplicationInsightsResourceName: # string. Required when Action == Enable Continuous Monitoring. Application Insights resource name. 
  # Advanced Settings
    #ApplicationInsightsWebTestName: # string. Optional. Use when Action == Enable Continuous Monitoring. Application Insights web test name.
```

--------------------------------

### Example: environment string with resource name

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/jobs-deployment-environment

Example of using the string syntax with a resource name and a runOnce deployment strategy.

```yaml
environment: environmentName.resourceName
strategy:                 # deployment strategy
  runOnce:              # default strategy
    deploy:
      steps:
      - script: echo Hello world

```

--------------------------------

### Install latest kubectl version with KubectlInstaller@0

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/kubectl-installer-v0

Example YAML that installs the latest version of kubectl on the agent. The kubectlVersion input is set to 'latest'.

```yaml
- task: KubectlInstaller@0
  displayName: Kubectl installer
  inputs: 
    kubectlVersion: latest

```

--------------------------------

### Full pipeline example for Linux

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/artifacts/cargo-pipelines

A complete YAML pipeline example for Linux agents that installs Rustup, authenticates with CargoAuthenticate, builds the project, and publishes to a feed.

```yaml
trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- script: |
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
   echo "##vso[task.prependpath]$HOME/.cargo/bin"
  displayName: Install

- task: CargoAuthenticate@0
  displayName: 'cargo Authenticate'
  inputs:
    configFile: '.cargo/config.toml'

- script: |
   cargo build --all
  displayName: Build

- powershell: |
   cargo publish --registry CargoInternalFeed
  displayName: Publish
```

--------------------------------

### Simple pipeline with trigger, pool, and script step

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/pipeline

Minimal pipeline example with a trigger on the `main` branch, an Ubuntu-latest hosted pool, and a single `script` step that prints "Hello world!". Use this as a starting point for a simple pipeline.

```yaml
trigger:
- main

pool: 
  vmImage: ubuntu-latest

steps:
- script: "Hello world!"
```

--------------------------------

### Install Node 6 runner just-in-time

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/node-task-runner-installer-v0

Example showing how to install the Node 6 runner just-in-time so an older task can run. Uses the runnerVersion alias for the nodeVersion input.

```yaml
  steps:
  - task: NodeTaskRunnerInstaller@0
    inputs:
      runnerVersion: 6

```

--------------------------------

### Secure install.sh script example

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/apps/cd/azure/deploy-virtual-scale-set-java

Example install.sh script following security practices: exits on errors, avoids unnecessary sudo, and only performs necessary operations.

```bash
#!/bin/bash
set -e  # Exit on any error
set -o pipefail  # Exit if any command in pipeline fails

# Only run operations necessary for application setup
# Avoid unnecessary sudo where possible

echo "Installing application dependencies..."
# Add your installation commands here

```

--------------------------------

### Install explicit kubectl version 1.15.0 with KubectlInstaller@0

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/kubectl-installer-v0

Example YAML that installs a specific kubectl version (1.15.0) instead of the latest. The kubectlVersion input is set to '1.15.0'.

```yaml
- task: KubectlInstaller@0
  displayName: Kubectl installer
  inputs: 
    kubectlVersion: 1.15.0

```

--------------------------------

### Install pip, setuptools, and wheel

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/ecosystems/customize-python

Installs or upgrades pip, setuptools, and wheel packages using a script element.

```yaml
- script: python -m pip install --upgrade pip setuptools wheel
  displayName: 'Install tools'

```

--------------------------------

### Install Docker CLI with DockerInstaller@0

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/docker-installer-v0

Example YAML pipeline that installs the Docker CLI on the agent machine using the DockerInstaller@0 task with a specific version and release type.

```yaml
- task: DockerInstaller@0
  displayName: Docker Installer
  inputs:
    dockerVersion: 17.09.0-ce
    releaseType: stable

```
Tokens:
Raw