Sablon paraméterei
A paramétereket és az adattípusokat megadhatja egy sablonban, és hivatkozhat ezekre a paraméterekre egy folyamatban. A templateContext használatával tulajdonságokat is átadhat a sablonban paraméterekként használt szakaszoknak, lépéseknek és feladatoknak.
A sablonon kívüli paramétereket is használhatja. A paraméter alapértelmezett értékeihez csak literálokat használhat. További információ a YAML-séma paramétereiről.
Paraméterek átadása
A paramétereknek nevet és adattípust kell tartalmazniuk. Ha azure-pipelines.yml
a paraméter yesNo
logikai értékre van állítva, a build sikeres lesz. Ha yesNo
például egy sztringre apples
van állítva, a build meghiúsul.
# File: simple-param.yml
parameters:
- name: yesNo # name of the parameter; required
type: boolean # data type of the parameter; required
default: false
steps:
- script: echo ${{ parameters.yesNo }}
# File: azure-pipelines.yml
trigger:
- main
extends:
template: simple-param.yml
parameters:
yesNo: false # set to a non-boolean value to have the build fail
Tulajdonságok átadása sablonoknak a templateContext használatával
További tulajdonságokat adhat templateContext
át a sablonban paraméterekként használt szakaszoknak, lépéseknek és feladatoknak. Pontosabban megadhatja templateContext
a , deploymentList
vagy stageList
paraméter jobList
adattípusát.
Az egyes feladatok feldolgozásakor egyszerűbbé teheti templateContext
a környezetek beállítását. A feladatok és a környezettulajdonságok objektumainak összekapcsolásával templateContext
könnyebben megértheti a YAML-et.
Ebben a példában a paraméter testSet
testing-template.yml
adattípusa jobList
van. A sablon testing-template.yml
minden kulcsszóval létrehoz egy új változót testJob
. A sablon ezután a testJob.templateContext.expectedHTTPResponseCode
beállítva azure-pipeline.yml
és a sablonnak átadott sablonra hivatkozik.
Ha a válaszkód 200, a sablon REST-kérést küld. Ha a válaszkód 500, a sablon az összes környezeti változót megjeleníti a hibakereséshez.
templateContext
tulajdonságokat tartalmazhat.
#testing-template.yml
parameters:
- name: testSet
type: jobList
jobs:
- ${{ each testJob in parameters.testSet }}:
- ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 200) }}:
- job:
steps:
- powershell: 'Invoke-RestMethod -Uri https://blogs.msdn.microsoft.com/powershell/feed/ | Format-Table -Property Title, pubDate'
- ${{ testJob.steps }}
- ${{ if eq(testJob.templateContext.expectedHTTPResponseCode, 500) }}:
- job:
steps:
- powershell: 'Get-ChildItem -Path Env:\'
- ${{ testJob.steps }}
#azure-pipeline.yml
trigger: none
pool:
vmImage: ubuntu-latest
extends:
template: testing-template.yml
parameters:
testSet:
- job: positive_test
templateContext:
expectedHTTPResponseCode: 200
steps:
- script: echo "Run positive test"
- job: negative_test
templateContext:
expectedHTTPResponseCode: 500
steps:
- script: echo "Run negative test"
Paraméterek a sablon futásidőben való kiválasztásához
A folyamat YAML-sablonjaitól különböző sablonokat hívhat meg egy feltételtől függően. Ebben a példában a experimental.yml
YAML akkor fut, ha a paraméter experimentalTemplate
igaz.
#azure-pipeline.yml
parameters:
- name: experimentalTemplate
displayName: 'Use experimental build process?'
type: boolean
default: false
steps:
- ${{ if eq(parameters.experimentalTemplate, true) }}:
- template: experimental.yml
- ${{ if not(eq(parameters.experimentalTemplate, true)) }}:
- template: stable.yml
Paraméter adattípusai
A stepList, stepList, job, jobList, deployment, deploymentList, stage és stageList adattípusok mind szabványos YAML-sémaformátumot használnak. Ez a példa sztringet, számot, logikai értéket, objektumot, lépést és stepListet tartalmaz.
parameters:
- name: myString
type: string
default: a string
- name: myMultiString
type: string
default: default
values:
- default
- ubuntu
- name: myNumber
type: number
default: 2
values:
- 1
- 2
- 4
- 8
- 16
- name: myBoolean
type: boolean
default: true
- name: myObject
type: object
default:
foo: FOO
bar: BAR
things:
- one
- two
- three
nested:
one: apple
two: pear
count: 3
- name: myStep
type: step
default:
script: echo my step
- name: mySteplist
type: stepList
default:
- script: echo step one
- script: echo step two
trigger: none
jobs:
- job: stepList
steps: ${{ parameters.mySteplist }}
- job: myStep
steps:
- ${{ parameters.myStep }}
Iterálhat egy objektumon keresztül, és kinyomtathatja az objektum minden sztringét.
parameters:
- name: listOfStrings
type: object
default:
- one
- two
steps:
- ${{ each value in parameters.listOfStrings }}:
- script: echo ${{ value }}
Emellett az objektumon belüli beágyazott elemeken keresztül is iterálhat.
parameters:
- name: listOfFruits
type: object
default:
- fruitName: 'apple'
colors: ['red','green']
- fruitName: 'lemon'
colors: ['yellow']
steps:
- ${{ each fruit in parameters.listOfFruits }} :
- ${{ each fruitColor in fruit.colors}} :
- script: echo ${{ fruit.fruitName}} ${{ fruitColor }}
Kötelező paraméterek
A sablon elején hozzáadhat egy érvényesítési lépést a szükséges paraméterek ellenőrzéséhez.
Íme egy példa, amely a Paramétert a solution
Bash használatával ellenőrzi (amely lehetővé teszi, hogy bármilyen platformon működjön):
# File: steps/msbuild.yml
parameters:
- name: 'solution'
default: ''
type: string
steps:
- bash: |
if [ -z "$SOLUTION" ]; then
echo "##vso[task.logissue type=error;]Missing template parameter \"solution\""
echo "##vso[task.complete result=Failed;]"
fi
env:
SOLUTION: ${{ parameters.solution }}
displayName: Check for required parameters
- task: msbuild@1
inputs:
solution: ${{ parameters.solution }}
- task: vstest@2
inputs:
solution: ${{ parameters.solution }}
Annak megjelenítése, hogy a sablon meghiúsul, ha hiányzik a szükséges paraméter:
# File: azure-pipelines.yml
# This will fail since it doesn't set the "solution" parameter to anything,
# so the template will use its default of an empty string
steps:
- template: steps/msbuild.yml
Paramétereket adhat át a sablonoknak.
A parameters
szakasz meghatározza, hogy mely paraméterek érhetők el a sablonban, és melyek az alapértelmezett értékek.
A sablonok a folyamat futtatása előtt ki vannak bontva, hogy a körülvett ${{ }}
értékeket a beágyazó folyamattól kapott paraméterek válthassák fel. Ennek eredményeképpen csak előre definiált változók használhatók a paraméterekben.
Ha több folyamat paramétereit szeretné használni, tekintse meg, hogyan hozhat létre változócsoportot.
Feladat-, szakasz- és lépéssablonok paraméterekkel
# File: templates/npm-with-params.yml
parameters:
name: '' # defaults for any parameters that aren't specified
vmImage: ''
jobs:
- job: ${{ parameters.name }}
pool:
vmImage: ${{ parameters.vmImage }}
steps:
- script: npm install
- script: npm test
Amikor felhasználja a sablont a folyamatban, adja meg a sablon paramétereinek értékeit.
# 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-10.13'
- template: templates/npm-with-params.yml # Template reference
parameters:
name: Windows
vmImage: 'windows-latest'
A paramétereket lépés- vagy szakaszsablonokkal is használhatja. Például a paraméterekkel rendelkező lépések:
# File: templates/steps-with-params.yml
parameters:
runExtendedTests: 'false' # defaults for any parameters that aren't specified
steps:
- script: npm test
- ${{ if eq(parameters.runExtendedTests, 'true') }}:
- script: npm test --extended
Amikor felhasználja a sablont a folyamatban, adja meg a sablon paramétereinek értékeit.
# File: azure-pipelines.yml
steps:
- script: npm install
- template: templates/steps-with-params.yml # Template reference
parameters:
runExtendedTests: 'true'
Megjegyzés:
A skaláris paramétereket a rendszer mindig sztringként kezeli.
Például szinte mindig vissza fog térni , eq(parameters['myparam'], true)
még akkor is, ha a myparam
paraméter a szó false
.true
A nem üres sztringek logikai környezetbe kerülnek true
.
A kifejezés átírható a sztringek explicit összehasonlítása érdekében: eq(parameters['myparam'], 'true')
.
A paraméterek nem korlátozódnak skaláris sztringekre. Mindaddig, amíg a paraméter kibontási helye leképezést vár, a paraméter lehet leképezés. Hasonlóképpen, a sorozatok átadhatók ott, ahol a sorozatok várhatók. Például:
# 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:
pool: {}
jobs:
- job: build
pool: ${{ parameters.pool }}