Malluttryck

Artikel
10/25/2024

Använd malluttryck för att ange hur värden ska matchas dynamiskt under pipelineinitieringen. Omsluta malluttrycket i den här syntaxen: ${{ }}.

Malluttryck kan expandera mallparametrar och även variabler. Du kan använda parametrar för att påverka hur en mall expanderas. Objektet parameters fungerar som objektet variables i ett uttryck. Endast fördefinierade variabler kan användas i malluttryck.

Kommentar

Uttryck expanderas endast för stages, jobs, stepsoch containers (inuti resources). Du kan till exempel inte använda ett uttryck i trigger eller en resurs som repositories. På Azure DevOps 2020 RTW kan du dessutom inte använda malluttryck i containers.

Du kan till exempel definiera en mall:

# File: steps/msbuild.yml

parameters:
- name: 'solution'
  default: '**/*.sln'
  type: string

steps:
- task: msbuild@1
  inputs:
    solution: ${{ parameters['solution'] }}  # index syntax
- task: vstest@2
  inputs:
    solution: ${{ parameters.solution }}  # property dereference syntax

Sedan refererar du till mallen och skickar den den valfria solution parametern:

# File: azure-pipelines.yml

steps:
- template: steps/msbuild.yml
  parameters:
    solution: my.sln

Kontext

I ett malluttryck har du åtkomst till kontexten parameters som innehåller värdena för de parametrar som skickas in. Dessutom har du åtkomst till kontexten variables som innehåller alla variabler som anges i YAML-filen plus många av de fördefinierade variablerna (noteras för varje variabel i den artikeln). Det är viktigt att den inte har körningsvariabler som de som lagras på pipelinen eller ges när du startar en körning. Mallexpansion sker tidigt i körningen, så dessa variabler är inte tillgängliga.

Malluttrycksfunktioner

Du kan använda allmänna funktioner i dina mallar. Du kan också använda några malluttrycksfunktioner.

format

Enkel ersättning av strängtoken
Minsta parametrar: 2. Maxparametrar: N
Exempel: ${{ format('{0} Build', parameters.os) }} → 'Windows Build'

sammansmälta

Utvärderar till det första icke-tomma, icke-null-strängargumentet
Minsta parametrar: 2. Maxparametrar: N
Exempel:

parameters:
- name: 'restoreProjects'
  default: ''
  type: string
- name: 'buildProjects'
  default: ''
  type: string

steps:
- script: echo ${{ coalesce(parameters.foo, parameters.bar, 'Nothing to see') }}

Insättning

Du kan använda malluttryck för att ändra strukturen för en YAML-pipeline. Om du till exempel vill infoga i en sekvens:

# File: jobs/build.yml

parameters:
- name: 'preBuild'
  type: stepList
  default: []
- name: 'preTest'
  type: stepList
  default: []
- name: 'preSign'
  type: stepList
  default: []

jobs:
- job: Build
  pool:
    vmImage: 'windows-latest'
  steps:
  - script: cred-scan
  - ${{ parameters.preBuild }}
  - task: msbuild@1
  - ${{ parameters.preTest }}
  - task: vstest@2
  - ${{ parameters.preSign }}
  - script: sign

# File: .vsts.ci.yml

jobs:
- template: jobs/build.yml
  parameters:
    preBuild:
    - script: echo hello from pre-build
    preTest:
    - script: echo hello from pre-test

När en matris infogas i en matris plattas den kapslade matrisen ut.

Om du vill infoga i en mappning använder du specialegenskapen ${{ insert }}.

# Default values
parameters:
- name: 'additionalVariables'
  type: object
  default: {}

jobs:
- job: build
  variables:
    configuration: debug
    arch: x86
    ${{ insert }}: ${{ parameters.additionalVariables }}
  steps:
  - task: msbuild@1
  - task: vstest@2

jobs:
- template: jobs/build.yml
  parameters:
    additionalVariables:
      TEST_SUITE: L0,L1

Villkorsstyrd infogning

Om du vill infoga villkorsstyrt i en sekvens eller en mappning i en mall använder du infogningar och uttrycksutvärdering. Du kan också använda if instruktioner utanför mallar så länge du använder mallsyntax.

Om du till exempel vill infoga i en sekvens i en mall:

# File: steps/build.yml

parameters:
- name: 'toolset'
  default: msbuild
  type: string
  values:
  - msbuild
  - dotnet

steps:
# msbuild
- ${{ if eq(parameters.toolset, 'msbuild') }}:
  - task: msbuild@1
  - task: vstest@2

# dotnet
- ${{ if eq(parameters.toolset, 'dotnet') }}:
  - task: dotnet@1
    inputs:
      command: build
  - task: dotnet@1
    inputs:
      command: test

# File: azure-pipelines.yml

steps:
- template: steps/build.yml
  parameters:
    toolset: dotnet

Om du till exempel vill infoga i en mappning i en mall:

# File: steps/build.yml

parameters:
- name: 'debug'
  type: boolean
  default: false

steps:
- script: tool
  env:
    ${{ if eq(parameters.debug, true) }}:
      TOOL_DEBUG: true
      TOOL_DEBUG_DIR: _dbg

steps:
- template: steps/build.yml
  parameters:
    debug: true

Du kan också använda villkorsstyrd infogning för variabler. I det här exemplet start skrivs alltid ut och this is a test skrivs bara ut när variabeln foo är lika med test.

variables:
  - name: foo
    value: test

pool:
  vmImage: 'ubuntu-latest'

steps:
- script: echo "start" # always runs
- ${{ if eq(variables.foo, 'test') }}:
  - script: echo "this is a test" # runs when foo=test

Du kan också ange variabler baserat på värdena för andra variabler. I följande pipeline myVar används för att ange värdet conditionalVarför .

trigger:
- main

pool: 
   vmImage: 'ubuntu-latest' 

variables:
  - name: myVar
    value: 'baz'

  - name: conditionalVar
    ${{ if eq(variables['myVar'], 'foo') }}:
      value: 'bar'
    ${{ elseif eq(variables['myVar'], 'baz') }}:
      value: 'qux'
    ${{ else }}:
      value: 'default'

steps:
- script: echo "start" # always runs
- ${{ if eq(variables.conditionalVar, 'bar') }}:
  - script: echo "the value of myVar is set in the if condition" # runs when myVar=foo
- ${{ if eq(variables.conditionalVar, 'qux') }}:
  - script: echo "the value of myVar is set in the elseif condition" # runs when myVar=baz

Iterativ insättning

Direktivet each tillåter iterativ infogning baserat på en YAML-sekvens (matris) eller mappning (nyckel/värde-par).

Du kan till exempel omsluta stegen för varje jobb med andra för- och eftersteg:

# job.yml
parameters:
- name: 'jobs'
  type: jobList
  default: []

jobs:
- ${{ each job in parameters.jobs }}: # Each job
  - ${{ each pair in job }}:          # Insert all properties other than "steps"
      ${{ if ne(pair.key, 'steps') }}:
        ${{ pair.key }}: ${{ pair.value }}
    steps:                            # Wrap the steps
    - task: SetupMyBuildTools@1       # Pre steps
    - ${{ job.steps }}                # Users steps
    - task: PublishMyTelemetry@1      # Post steps
      condition: always()

# azure-pipelines.yml
jobs:
- template: job.yml
  parameters:
    jobs:
    - job: A
      steps:
      - script: echo This will get sandwiched between SetupMyBuildTools and PublishMyTelemetry.
    - job: B
      steps:
      - script: echo So will this!

Du kan också ändra egenskaperna för det du itererar över. Om du till exempel vill lägga till fler beroenden:

# job.yml
parameters:
- name: 'jobs'
  type: jobList
  default: []

jobs:
- job: SomeSpecialTool                # Run your special tool in its own job first
  steps:
  - task: RunSpecialTool@1
- ${{ each job in parameters.jobs }}: # Then do each job
  - ${{ each pair in job }}:          # Insert all properties other than "dependsOn"
      ${{ if ne(pair.key, 'dependsOn') }}:
        ${{ pair.key }}: ${{ pair.value }}
    dependsOn:                        # Inject dependency
    - SomeSpecialTool
    - ${{ if job.dependsOn }}:
      - ${{ job.dependsOn }}

# azure-pipelines.yml
jobs:
- template: job.yml
  parameters:
    jobs:
    - job: A
      steps:
      - script: echo This job depends on SomeSpecialTool, even though it's not explicitly shown here.
    - job: B
      dependsOn:
      - A
      steps:
      - script: echo This job depends on both Job A and on SomeSpecialTool.

Undvik ett värde

Om du behöver undvika ett värde som bokstavligen innehåller , omsluter ${{du värdet i en uttryckssträng. Till exempel ${{ 'my${{value' }} eller ${{ 'my${{value with a '' single quote too' }}

Dela via