Referens för mallanvändning

För att öka säkerheten kan du framtvinga att en pipeline utökas från en viss mall. Filen start.yml definierar parametern buildSteps, som sedan används i pipelinen azure-pipelines.yml. I start.yml, om en buildStep skickas med ett skriptsteg, avvisas den och pipeline-versionen misslyckas. När du utökar från en mall kan du öka säkerheten genom att lägga till ett obligatoriskt mallgodkännande.

# File: start.yml
parameters:
- name: buildSteps # the name of the parameter is buildSteps
  type: stepList # data type is StepList
  default: [] # default value of buildSteps
stages:
- stage: secure_buildstage
  pool:
    vmImage: windows-latest
  jobs:
  - job: secure_buildjob
    steps:
    - script: echo This happens before code 
      displayName: 'Base: Pre-build'
    - script: echo Building
      displayName: 'Base: Build'

    - ${{ each step in parameters.buildSteps }}:
      - ${{ each pair in step }}:
          ${{ if ne(pair.value, 'CmdLine@2') }}:
            ${{ pair.key }}: ${{ pair.value }}       
          ${{ if eq(pair.value, 'CmdLine@2') }}: 
            # Step is rejected by raising a YAML syntax error: Unexpected value 'CmdLine@2'
            '${{ pair.value }}': error         

    - script: echo This happens after code
      displayName: 'Base: Signing'

# File: azure-pipelines.yml
trigger:
- main

extends:
  template: start.yml
  parameters:
    buildSteps:  
      - bash: echo Test #Passes
        displayName: succeed
      - bash: echo "Test"
        displayName: succeed
      # Step is rejected by raising a YAML syntax error: Unexpected value 'CmdLine@2'
      - task: CmdLine@2
        inputs:
          script: echo "Script Test"
      # Step is rejected by raising a YAML syntax error: Unexpected value 'CmdLine@2'
      - script: echo "Script Test"

Utöka från en mall med resurser

Du kan också använda extends för att utöka från en mall i din Azure-pipeline som innehåller resurser.

# File: azure-pipelines.yml
trigger:
- none

extends:
  template: resource-template.yml

# File: resource-template.yml
resources:
  pipelines:
  - pipeline: my-pipeline 
    source: sourcePipeline

steps:
- script: echo "Testing resource template"

Du kan kopiera innehåll från en YAML och återanvända det i en annan YAML. Om du kopierar innehåll från en YAML till en annan kan du inte behöva inkludera samma logik manuellt på flera platser. Filmallen include-npm-steps.yml innehåller steg som återanvänds i azure-pipelines.yml.

# File: templates/include-npm-steps.yml

steps:
- script: npm install
- script: yarn install
- script: npm run compile

# File: azure-pipelines.yml

jobs:
- job: Linux
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - template: templates/include-npm-steps.yml  # Template reference
- job: Windows
  pool:
    vmImage: 'windows-latest'
  steps:
  - template: templates/include-npm-steps.yml  # Template reference

Steg för återanvändning

Du kan infoga en mall för att återanvända ett eller flera steg i flera jobb. Förutom stegen från mallen kan varje jobb definiera fler steg.

# File: templates/npm-steps.yml
steps:
- script: npm install
- script: npm test

# File: azure-pipelines.yml

jobs:
- job: Linux
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - template: templates/npm-steps.yml  # Template reference

- job: macOS
  pool:
    vmImage: 'macOS-latest'
  steps:
  - template: templates/npm-steps.yml  # Template reference

- job: Windows
  pool:
    vmImage: 'windows-latest'
  steps:
  - script: echo This script runs before the template's steps, only on Windows.
  - template: templates/npm-steps.yml  # Template reference
  - script: echo This step runs after the template's steps.

Återanvändning av jobb

Precis som med steg kan jobb återanvändas med mallar.

# File: templates/jobs.yml
jobs:
- job: Ubuntu
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - bash: echo "Hello Ubuntu"

- job: Windows
  pool:
    vmImage: 'windows-latest'
  steps:
  - bash: echo "Hello Windows"

# File: azure-pipelines.yml

jobs:
- template: templates/jobs.yml  # Template reference

När du arbetar med flera jobb bör du komma ihåg att ta bort namnet på jobbet i mallfilen för att undvika konflikter

# File: templates/jobs.yml
jobs:
- job: 
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - bash: echo "Hello Ubuntu"

- job:
  pool:
    vmImage: 'windows-latest'
  steps:
  - bash: echo "Hello Windows"

# File: azure-pipelines.yml

jobs:
- template: templates/jobs.yml  # Template reference
- template: templates/jobs.yml  # Template reference
- template: templates/jobs.yml  # Template reference

Återanvändning av steg

Steg kan också återanvändas med mallar.

# File: templates/stages1.yml
stages:
- stage: Angular
  jobs:
  - job: angularinstall
    steps:
    - script: npm install angular

# File: templates/stages2.yml
stages:
- stage: Build
  jobs:
  - job: build
    steps:
    - script: npm run build

# File: azure-pipelines.yml
trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

stages:
- stage: Install
  jobs: 
  - job: npminstall
    steps:
    - task: Npm@1
      inputs:
        command: 'install'
- template: templates/stages1.yml # Template reference
- template: templates/stages2.yml # Template reference

Jobb-, fas- och stegmallar med parametrar

I följande mallar:

• templates/npm-with-params.yml definierar två parametrar: name och vmImage skapar ett jobb med namnparametern för jobbnamnet och parametern vmImage för VM-avbildningen.
• Pipelinen (azure-pipelines.yml) refererar till mallen tre gånger, var och en med olika parametervärden som refererar till operativsystem- och VM-avbildningsnamnen.
• Den byggda pipelinen körs på en annan VM-avbildning och namnges enligt det angivna operativsystemet. Varje jobb utför npm-installations- och npm-teststeg.

# File: templates/npm-with-params.yml

parameters:
- name: name  # defaults for any parameters that aren't specified
  default: ''
- name: vmImage
  default: ''

jobs:
- job: ${{ parameters.name }}
  pool: 
    vmImage: ${{ parameters.vmImage }}
  steps:
  - script: npm install
  - script: npm test

När du använder mallen i pipelinen anger du värden för mallparametrarna.

# File: azure-pipelines.yml

jobs:
- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: Linux
    vmImage: 'ubuntu-latest'

- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: macOS
    vmImage: 'macOS-latest'

- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: Windows
    vmImage: 'windows-latest'

Mellanlagra mallar med flera parametrar

I följande mallar:

• Mallen stage-template.yml definierar fyra parametrar: stageName, jobName, vmImageoch scriptPath, alla av typen sträng. Mallen skapar en fas med parametern stageName för att ange fasnamnet, definierar ett jobb med jobNameoch innehåller ett steg för att köra ett skript.
• Pipelinen , azure-pipeline.yml, definierar sedan steg och jobb dynamiskt med hjälp av parametrar och kör ett jobb som kör ett skript, build-script.sh.

# stage-template.yml

parameters:
  - name: stageName
    type: string
  - name: jobName
    type: string
  - name: vmImage
    type: string
  - name: scriptPath
    type: string

stages:
  - stage: ${{ parameters.stageName }}
    jobs:
      - job: ${{ parameters.jobName }}
        pool:
          vmImage: ${{ parameters.vmImage }}
        steps:
          - script: ./${{ parameters.scriptPath }}

# azure-pipelines.yml
trigger:
- main

stages:
- template: stage-template.yml
  parameters:
    stageName: 'BuildStage'
    jobName: 'BuildJob'
    scriptPath: 'build-script.sh' # replace with script in your repository
    vmImage: 'ubuntu-latest'

Mallar med steg och parametrar

Du kan också använda parametrar med steg- eller stegmallar.

I följande mallar:

• Mallen (templates/steps-with-params.yml) definierar en parameter med namnet runExtendedTests med standardvärdet false.
• Pipelinen (azure-pipelines.yml) körs npm test och npm test --extended eftersom parametern runExtendedTests är sann.

# File: templates/steps-with-params.yml

parameters:
- name: 'runExtendedTests'  # defaults for any parameters that aren't specified
  type: boolean
  default: false

steps:
- script: npm test
- ${{ if eq(parameters.runExtendedTests, true) }}:
  - script: npm test --extended

När du använder mallen i pipelinen anger du värden för mallparametrarna.

# File: azure-pipelines.yml

steps:
- script: npm install

- template: templates/steps-with-params.yml  # Template reference
  parameters:
    runExtendedTests: 'true'

Parametrar är inte begränsade till skalärsträngar. Se listan över datatyper. Du kan till exempel använda typen object :

# azure-pipelines.yml
jobs:
- template: process.yml
  parameters:
    pool:   # this parameter is called `pool`
      vmImage: ubuntu-latest  # and it's a mapping rather than a string


# process.yml
parameters:
- name: 'pool'
  type: object
  default: {}

jobs:
- job: build
  pool: ${{ parameters.pool }}

Återanvändning av variabel

Variabler kan definieras i en YAML och ingå i en annan mall. Detta kan vara användbart om du vill lagra alla dina variabler i en fil. Om du använder en mall för att inkludera variabler i en pipeline kan den inkluderade mallen endast användas för att definiera variabler. Du kan använda steg och mer komplex logik när du utökar från en mall. Använd parametrar i stället för variabler när du vill begränsa typen.

I det här exemplet ingår variabeln favoriteVeggie i azure-pipelines.yml.

# File: vars.yml
variables:
  favoriteVeggie: 'brussels sprouts'

# File: azure-pipelines.yml

variables:
- template: vars.yml  # Template reference

steps:
- script: echo My favorite vegetable is ${{ variables.favoriteVeggie }}.

Variabelmallar med parameter

Du kan skicka parametrar till variabler med mallar. I det här exemplet skickar du parametern DIRECTORY till en RELEASE_COMMAND variabel.

# File: templates/package-release-with-params.yml

parameters:
- name: DIRECTORY 
  type: string
  default: "." # defaults for any parameters that specified with "." (current directory)

variables:
- name: RELEASE_COMMAND
  value: grep version ${{ parameters.DIRECTORY }}/package.json | awk -F \" '{print $4}'  

När du använder mallen i pipelinen anger du värden för mallparametrarna.

# File: azure-pipelines.yml

variables: # Global variables
  - template: package-release-with-params.yml # Template reference
    parameters:
      DIRECTORY: "azure/checker"

pool:
  vmImage: 'ubuntu-latest'

stages:
- stage: Release_Stage 
  displayName: Release Version
  variables: # Stage variables
  - template: package-release-with-params.yml  # Template reference
    parameters:
      DIRECTORY: "azure/todo-list"
  jobs: 
  - job: A
    steps: 
    - bash: $(RELEASE_COMMAND) #output release command