Výrazy šablon

Článek
10/25/2024

Pomocí výrazů šablon můžete určit, jak se hodnoty dynamicky překládají během inicializace kanálu. Zabalte výraz šablony do této syntaxe: ${{ }}.

Výrazy šablon mohou rozšířit parametry šablony a také proměnné. Parametry můžete použít k ovlivnění způsobu rozbalení šablony. Objekt parameters funguje jako variables objekt ve výrazu. Ve výrazech šablon lze použít pouze předdefinované proměnné.

Poznámka:

Výrazy jsou rozbalené pouze pro stages, jobs, stepsa containers (uvnitř resources). Nemůžete například použít výraz uvnitř trigger ani prostředek, například repositories. Kromě toho v Azure DevOps 2020 RTW nemůžete použít výrazy šablon uvnitř containers.

Můžete například definovat šablonu:

# 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

Pak na šablonu odkazujete a předáte ji volitelný solution parametr:

# File: azure-pipelines.yml

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

Kontext

Ve výrazu šablony máte přístup k parameters kontextu, který obsahuje hodnoty parametrů předaných. Kromě toho máte přístup k variables kontextu, který obsahuje všechny proměnné zadané v souboru YAML a mnoho předdefinovaných proměnných (které jsou uvedené v každé proměnné v tomto článku). Důležité je, že nemá proměnné modulu runtime, jako jsou proměnné uložené v kanálu nebo zadané při spuštění spuštění. Rozšíření šablony probíhá v rané fázi spuštění, takže tyto proměnné nejsou dostupné.

Funkce výrazů šablon

V šablonách můžete používat obecné funkce . Můžete také použít několik funkcí výrazů šablony.

format

Nahrazení jednoduchého řetězcového tokenu
Minimální parametry: 2. Maximální parametry: N
Příklad: ${{ format('{0} Build', parameters.os) }} → 'Windows Build'

splynout

Vyhodnotí se jako první neprázdný, neprázdný řetězcový argument, který není null.
Minimální parametry: 2. Maximální parametry: N
Příklad:

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

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

Vložení

Pomocí výrazů šablon můžete změnit strukturu kanálu YAML. Například vložení do sekvence:

# 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

Při vložení pole do pole je vnořená matice zploštěná.

Chcete-li vložit do mapování, použijte speciální vlastnost ${{ 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

Podmíněné vložení

Pokud chcete podmíněně vložit do sekvence nebo mapování v šabloně, použijte vložení a vyhodnocení výrazu. Můžete také použít if příkazy mimo šablony, pokud používáte syntaxi šablony.

Například vložení do sekvence v šabloně:

# 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

Například vložení do mapování v šabloně:

# 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

Pro proměnné můžete také použít podmíněné vložení. V tomto příkladu se vždy vytiskne a this is a test vytiskne pouze tehdy, start když foo se proměnná rovná 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

Můžete také nastavit proměnné na základě hodnot jiných proměnných. V následujícím kanálu myVar se používá k nastavení hodnoty conditionalVar.

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

Iterativní vložení

Direktiva each umožňuje iterativní vkládání na základě sekvence YAML (pole) nebo mapování (páry klíč-hodnota).

Kroky jednotlivých úloh můžete například zabalit do dalších před a po krocích:

# 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!

Můžete také manipulovat s vlastnostmi toho, co iterujete. Pokud například chcete přidat další závislosti:

# 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.

Řídicí znak hodnoty

Pokud potřebujete uvést hodnotu, která doslova obsahuje ${{, zabalte hodnotu do řetězce výrazu. Příklad: ${{ 'my${{value' }} nebo ${{ 'my${{value with a '' single quote too' }}

Sdílet prostřednictvím