Sablonkifejezések

Cikk
01/31/2024

Sablonkifejezések használatával megadhatja, hogyan oldhatók fel dinamikusan az értékek a folyamat inicializálása során. A sablonkifejezés körbefuttatása ebben a szintaxisban: ${{ }}.

A sablonkifejezések kibonthatják a sablonparamétereket és a változókat is. A paraméterekkel befolyásolhatja a sablon kibontása módját. Az parameters objektum a kifejezésben lévő objektumhoz hasonlóan variables működik. Sablonkifejezésekben csak előre definiált változók használhatók.

Feljegyzés

A kifejezések csak a , , és containers (belülresources) kifejezéseket stagesbontják stepski. jobs Nem használhat például belső kifejezést trigger vagy erőforrást, például repositories. Emellett az Azure DevOps 2020 RTW-n belül nem használhat sablonkifejezéseket containers.

Definiálhat például egy sablont:

# 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

Ezután hivatkozzon a sablonra, és adja meg a választható solution paramétert:

# File: azure-pipelines.yml

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

Környezet

Egy sablonkifejezésen belül hozzáférhet a parameters megadott paraméterek értékeit tartalmazó környezethez. Emellett hozzáférhet ahhoz a variables környezethez, amely tartalmazza a YAML-fájlban megadott összes változót, valamint számos előre definiált változót (a cikkben szereplő változók esetében). Fontos, hogy nem rendelkezik futtatókörnyezeti változókkal, például a folyamaton tárolt vagy futtatás indításakor megadott futtatókörnyezeti változókkal. A sablonbővítés a futtatás korai szakaszában történik, így ezek a változók nem érhetők el.

Sablonkifejezési függvények

A sablonokban általános függvényeket használhat. Használhat néhány sablonkifejezési függvényt is.

format

Egyszerű sztring jogkivonat cseréje
Minimális paraméterek: 2. Maximális paraméterek: N
Példa: ${{ format('{0} Build', parameters.os) }} → 'Windows Build'

coalesce

Kiértékeli az első nem üres, nem null sztring argumentumot
Minimális paraméterek: 2. Maximális paraméterek: N
Példa:

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

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

Beszúrás

Sablonkifejezésekkel módosíthatja a YAML-folyamatok szerkezetét. Például beszúrhat egy sorozatba:

# 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

Amikor egy tömböt beszúr egy tömbbe, a beágyazott tömb ellaposodik.

Ha be szeretne szúrni egy leképezésbe, használja a speciális tulajdonságot ${{ 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

Feltételes beszúrás

Ha feltételesen szeretne beszúrni egy sorozatba vagy egy sablon leképezésébe, használjon beszúrásokat és kifejezéskiértékelést. A sablonokon kívüli utasításokat is használhatja if mindaddig, amíg sablonszintaxist használ.

Például egy sablonban lévő sorozatba való beszúráshoz:

# 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

Ha például be szeretne szúrni egy leképezésbe egy sablonban:

# 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

Feltételes beszúrást is használhat változókhoz. Ebben a példában mindig nyomtat és start csak akkor nyomtat, ha a foo változó egyenlőtest.this is a 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

Iteratív beszúrás

Az each irányelv lehetővé teszi az iteratív beszúrást YAML-sorozat (tömb) vagy leképezés (kulcs-érték párok) alapján.

Az egyes feladatok lépéseit például más elő- és utólépésekkel is körbefuttathatja:

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

Azt is módosíthatja, hogy milyen tulajdonságokat használ az iterálás során. Például további függőségek hozzáadásához:

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

Érték feloldása

Ha meg kell szabadulnia egy szó szerint tartalmazott ${{érték elől, akkor az értéket egy kifejezési sztringbe kell tördelnie. Például: ${{ 'my${{value' }} vagy ${{ 'my${{value with a '' single quote too' }}

Share via