Şablon parametreleri
Parametreleri ve bunların veri türlerini bir şablonda belirtebilir ve bu parametrelere işlem hattında başvurabilirsiniz. templateContext ile, özellikleri şablonda parametre olarak kullanılan aşamalara, adımlara ve işlere de geçirebilirsiniz.
Parametreleri şablonların dışında da kullanabilirsiniz. Değişmez değerleri yalnızca parametre varsayılan değerleri için kullanabilirsiniz. YAML şemasında parametreler hakkında daha fazla bilgi edinin.
Parametreleri geçirme
Parametreler bir ad ve veri türü içermelidir. içinde azure-pipelines.yml
parametresi yesNo
boole değerine ayarlandığında derleme başarılı olur. yesNo
gibi apples
bir dizeye ayarlandığında derleme başarısız olur.
# 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
Özellikleri şablonlara geçirmek için templateContext kullanma
Şablonda parametre olarak kullanılan aşamalara, adımlara ve işlere daha fazla özellik geçirmek için kullanabilirsiniz templateContext
. Özellikle, , deploymentList
veya stageList
parametre veri türü içinde jobList
belirtebilirsiniztemplateContext
.
Her işi işlerken ortamları ayarlamayı kolaylaştırmak için kullanabilirsiniz templateContext
. Bir işi ve ortam özellikleri nesnesini birlikte birleştirerek, templateContext
YAML'yi daha sürdürülebilir ve daha kolay anlamanıza yardımcı olabilir.
Bu örnekte parametresi testSet
testing-template.yml
veri türüne jobList
sahiptir. Şablontesting-template.yml
, her anahtar sözcüğü kullanarak yeni bir değişken testJob
oluşturur. Ardından şablon, içinde ayarlanıp azure-pipeline.yml
şablona geçirilen öğesine başvururtestJob.templateContext.expectedHTTPResponseCode
.
Yanıt kodu 200 olduğunda şablon bir REST isteğinde bulunur. Yanıt kodu 500 olduğunda, şablon hata ayıklama için tüm ortam değişkenlerini oluşturur.
templateContext
özellikleri içerebilir.
#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"
Çalışma zamanında şablon seçme parametreleri
Bir koşula bağlı olarak işlem hattı YAML'sinden farklı şablonlar çağırabilirsiniz. Bu örnekte, experimental.yml
parametre experimentalTemplate
true olduğunda YAML çalıştırılır.
#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
Parametre veri türleri
Veri türü | Notlar |
---|---|
string |
Dize |
number |
ile sınırlandırılmış values: olabilir, aksi takdirde sayı benzeri herhangi bir dize kabul edilir |
boolean |
true veya false |
object |
herhangi bir YAML yapısı |
step |
tek bir adım |
stepList |
adım dizisi |
job |
tek bir iş |
jobList |
iş sırası |
deployment |
tek dağıtım işi |
deploymentList |
dağıtım işlerinin sırası |
stage |
tek bir aşama |
stageList |
aşama dizisi |
Step, stepList, job, jobList, deployment, deploymentList, stage ve stageList veri türlerinin tümü standart YAML şema biçimini kullanır. Bu örnek dize, sayı, boole, nesne, adım ve stepList'i içerir.
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 }}
Bir nesnede yineleme yapabilir ve nesnedeki her dizeyi yazdırabilirsiniz.
parameters:
- name: listOfStrings
type: object
default:
- one
- two
steps:
- ${{ each value in parameters.listOfStrings }}:
- script: echo ${{ value }}
Ayrıca, bir nesnenin içindeki iç içe öğeler arasında yineleme yapabilirsiniz.
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 }}
Gerekli parametreler
İstediğiniz parametreleri denetlemek için şablonunuzun başına bir doğrulama adımı ekleyebilirsiniz.
Bash kullanarak parametreyi solution
denetleyen (herhangi bir platformda çalışmasını sağlayan) bir örnek aşağıda verilmiştir:
# 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 }}
Gerekli parametre eksikse şablonun başarısız olduğunu göstermek için:
# 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
Parametreleri şablonlara geçirebilirsiniz.
parameters
bölümü, şablonda hangi parametrelerin kullanılabilir olduğunu ve bunların varsayılan değerlerini tanımlar.
Şablonlar, işlem hattı çalışmadan hemen önce genişletilir, böylece ile ${{ }}
çevrelenen değerler, kapsayan işlem hattından aldığı parametrelerle değiştirilir. Sonuç olarak, parametrelerde yalnızca önceden tanımlanmış değişkenler kullanılabilir.
Parametreleri birden çok işlem hattında kullanmak için bkz. Değişken grubu oluşturma.
Parametrelerle iş, aşama ve adım şablonları
# 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
şablonu işlem hattınızda kullandığınızda, şablon parametreleri için değerleri belirtin.
# 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'
Parametreleri adım veya aşama şablonlarıyla da kullanabilirsiniz. Örneğin, parametreleri olan adımlar:
# 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
şablonu işlem hattınızda kullandığınızda, şablon parametreleri için değerleri belirtin.
# File: azure-pipelines.yml
steps:
- script: npm install
- template: templates/steps-with-params.yml # Template reference
parameters:
runExtendedTests: 'true'
Dekont
Skaler parametreler her zaman dize olarak değerlendirilir.
Örneğin, eq(parameters['myparam'], true)
parametresi sözcüğü false
olsa myparam
bile neredeyse her zaman döndürürtrue
.
Boş olmayan dizeler Boole bağlamında olarak oluşturulur true
.
Bu ifade , dizeleri açıkça karşılaştırmak için yeniden yazılabilir: eq(parameters['myparam'], 'true')
.
Parametreler skaler dizelerle sınırlı değildir. Parametresinin genişletildiği yer bir eşleme beklediği sürece, parametre bir eşleme olabilir. Benzer şekilde, dizilerin beklendiği yerde diziler geçirilebilir. Örneğin:
# 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 }}