Şablon kullanım başvurusu

Güvenliği artırmak için, bir işlem hattının belirli bir şablondan genişletildiğini zorlayabilirsiniz. dosyasıstart.yml, işlem hattında azure-pipelines.ymlkullanılan parametresini buildStepstanımlar. içinde start.yml, bir buildStep betik adımıyla geçirilirse reddedilir ve işlem hattı derlemesi başarısız olur. Şablondan genişletirken, gerekli bir şablon onayı ekleyerek güvenliği artırabilirsiniz.

# File: start.yml
parameters:
- name: buildSteps # the name of the parameter is buildSteps
  type: stepList # data type is StepList
  default: [] # default value of buildSteps
stages:
- stage: secure_buildstage
  pool:
    vmImage: windows-latest
  jobs:
  - job: secure_buildjob
    steps:
    - script: echo This happens before code 
      displayName: 'Base: Pre-build'
    - script: echo Building
      displayName: 'Base: Build'

    - ${{ each step in parameters.buildSteps }}:
      - ${{ each pair in step }}:
          ${{ if ne(pair.value, 'CmdLine@2') }}:
            ${{ pair.key }}: ${{ pair.value }}       
          ${{ if eq(pair.value, 'CmdLine@2') }}: 
            # Step is rejected by raising a YAML syntax error: Unexpected value 'CmdLine@2'
            '${{ pair.value }}': error         

    - script: echo This happens after code
      displayName: 'Base: Signing'

# File: azure-pipelines.yml
trigger:
- main

extends:
  template: start.yml
  parameters:
    buildSteps:  
      - bash: echo Test #Passes
        displayName: succeed
      - bash: echo "Test"
        displayName: succeed
      # Step is rejected by raising a YAML syntax error: Unexpected value 'CmdLine@2'
      - task: CmdLine@2
        inputs:
          script: echo "Script Test"
      # Step is rejected by raising a YAML syntax error: Unexpected value 'CmdLine@2'
      - script: echo "Script Test"

Kaynaklarla şablondan genişletme

Kaynakları içeren Azure işlem hattınızdaki bir şablondan genişletmek için de kullanabilirsiniz extends .

# File: azure-pipelines.yml
trigger:
- none

extends:
  template: resource-template.yml

# File: resource-template.yml
resources:
  pipelines:
  - pipeline: my-pipeline 
    source: sourcePipeline

steps:
- script: echo "Testing resource template"

Bir YAML'den içerik kopyalayabilir ve farklı bir YAML'de yeniden kullanabilirsiniz. Bir YAML'den diğerine içerik kopyalamak, aynı mantığı birden çok yere el ile eklemek zorunda kalmadan sizi kurtarır. Dosya include-npm-steps.yml şablonu içinde azure-pipelines.ymlyeniden kullanılan adımları içerir.

# File: templates/include-npm-steps.yml

steps:
- script: npm install
- script: yarn install
- script: npm run compile

# File: azure-pipelines.yml

jobs:
- job: Linux
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - template: templates/include-npm-steps.yml  # Template reference
- job: Windows
  pool:
    vmImage: 'windows-latest'
  steps:
  - template: templates/include-npm-steps.yml  # Template reference

Adım yeniden kullanma

Birkaç işte bir veya daha fazla adımı yeniden kullanmak için şablon ekleyebilirsiniz. Şablondaki adımlara ek olarak, her iş daha fazla adım tanımlayabilir.

# File: templates/npm-steps.yml
steps:
- script: npm install
- script: npm test

# File: azure-pipelines.yml

jobs:
- job: Linux
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - template: templates/npm-steps.yml  # Template reference

- job: macOS
  pool:
    vmImage: 'macOS-latest'
  steps:
  - template: templates/npm-steps.yml  # Template reference

- job: Windows
  pool:
    vmImage: 'windows-latest'
  steps:
  - script: echo This script runs before the template's steps, only on Windows.
  - template: templates/npm-steps.yml  # Template reference
  - script: echo This step runs after the template's steps.

İş yeniden kullanımı

Adımlar gibi işler de şablonlarla yeniden kullanılabilir.

# File: templates/jobs.yml
jobs:
- job: Ubuntu
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - bash: echo "Hello Ubuntu"

- job: Windows
  pool:
    vmImage: 'windows-latest'
  steps:
  - bash: echo "Hello Windows"

# File: azure-pipelines.yml

jobs:
- template: templates/jobs.yml  # Template reference

Birden çok iş ile çalışırken, çakışmayı önlemek için şablon dosyasında işin adını kaldırmayı unutmayın

# File: templates/jobs.yml
jobs:
- job: 
  pool:
    vmImage: 'ubuntu-latest'
  steps:
  - bash: echo "Hello Ubuntu"

- job:
  pool:
    vmImage: 'windows-latest'
  steps:
  - bash: echo "Hello Windows"

# File: azure-pipelines.yml

jobs:
- template: templates/jobs.yml  # Template reference
- template: templates/jobs.yml  # Template reference
- template: templates/jobs.yml  # Template reference

Aşama yeniden kullanımı

Aşamalar şablonlarla da yeniden kullanılabilir.

# File: templates/stages1.yml
stages:
- stage: Angular
  jobs:
  - job: angularinstall
    steps:
    - script: npm install angular

# File: templates/stages2.yml
stages:
- stage: Build
  jobs:
  - job: build
    steps:
    - script: npm run build

# File: azure-pipelines.yml
trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

stages:
- stage: Install
  jobs: 
  - job: npminstall
    steps:
    - task: Npm@1
      inputs:
        command: 'install'
- template: templates/stages1.yml # Template reference
- template: templates/stages2.yml # Template reference

Parametrelerle iş, aşama ve adım şablonları

Aşağıdaki şablonlarda:

• templates/npm-with-params.yml iki parametre tanımlar: name ve vmImage iş adı için ad parametresiyle ve VM görüntüsü için vmImage parametresiyle bir iş oluşturur.
• İşlem hattı (azure-pipelines.yml), şablona üç kez başvurur ve her birinde işletim sistemi ve VM görüntü adlarına başvuran farklı parametre değerleri bulunur.
• Oluşturulan işlem hattı farklı bir VM görüntüsü üzerinde çalışır ve belirtilen işletim sistemine göre adlandırılır. Her iş npm yükleme ve npm test adımları gerçekleştirir.

# File: templates/npm-with-params.yml

parameters:
- name: name  # defaults for any parameters that aren't specified
  default: ''
- name: vmImage
  default: ''

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-latest'

- template: templates/npm-with-params.yml  # Template reference
  parameters:
    name: Windows
    vmImage: 'windows-latest'

Şablonları birden çok parametreyle hazırlama

Aşağıdaki şablonlarda:

• Şablon stage-template.yml dört parametre tanımlar: stageName, jobName, vmImage, ve scriptPath, tüm tür dizeleri. Şablon, aşama adını ayarlamak için parametresini stageName kullanarak bir aşama oluşturur, ile jobNamebir iş tanımlar ve bir betik çalıştırma adımı içerir.
• İşlem hattı, azure-pipeline.ymlardından parametreleri kullanarak aşamaları ve işleri dinamik olarak tanımlar ve betik build-script.shyürüten bir iş çalıştırır.

# stage-template.yml

parameters:
  - name: stageName
    type: string
  - name: jobName
    type: string
  - name: vmImage
    type: string
  - name: scriptPath
    type: string

stages:
  - stage: ${{ parameters.stageName }}
    jobs:
      - job: ${{ parameters.jobName }}
        pool:
          vmImage: ${{ parameters.vmImage }}
        steps:
          - script: ./${{ parameters.scriptPath }}

# azure-pipelines.yml
trigger:
- main

stages:
- template: stage-template.yml
  parameters:
    stageName: 'BuildStage'
    jobName: 'BuildJob'
    scriptPath: 'build-script.sh' # replace with script in your repository
    vmImage: 'ubuntu-latest'

Adım ve parametre içeren şablonlar

Parametreleri adım veya aşama şablonlarıyla da kullanabilirsiniz.

Aşağıdaki şablonlarda:

• Şablon (templates/steps-with-params.yml), varsayılan değeri false olan adlı runExtendedTests bir parametre tanımlar.
• İşlem hattı (azure-pipelines.yml) ve parametresi true olduğundan runExtendedTests çalışır npm test npm test --extended.

# File: templates/steps-with-params.yml

parameters:
- name: 'runExtendedTests'  # defaults for any parameters that aren't specified
  type: boolean
  default: false

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'

Parametreler skaler dizelerle sınırlı değildir. Veri türlerinin listesine bakın. Örneğin, türünü kullanarak object :

# 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:
- name: 'pool'
  type: object
  default: {}

jobs:
- job: build
  pool: ${{ parameters.pool }}

Değişken yeniden kullanımı

Değişkenler bir YAML'de tanımlanabilir ve başka bir şablona eklenebilir. Tüm değişkenlerinizi tek bir dosyada depolamak istiyorsanız bu yararlı olabilir. bir işlem hattına değişken eklemek için şablon kullanıyorsanız, dahil edilen şablon yalnızca değişkenleri tanımlamak için kullanılabilir. Bir şablondan genişletirken adımları ve daha karmaşık mantığı kullanabilirsiniz. Türü kısıtlamak istediğinizde değişkenler yerine parametreleri kullanın.

Bu örnekte değişkenine favoriteVeggie azure-pipelines.ymldahil edilir.

# File: vars.yml
variables:
  favoriteVeggie: 'brussels sprouts'

# File: azure-pipelines.yml

variables:
- template: vars.yml  # Template reference

steps:
- script: echo My favorite vegetable is ${{ variables.favoriteVeggie }}.

Parametresi olan değişken şablonları

Şablonlarla değişkenlere parametre geçirebilirsiniz. Bu örnekte parametresini DIRECTORY bir RELEASE_COMMAND değişkene geçiriyorsunuz.

# File: templates/package-release-with-params.yml

parameters:
- name: DIRECTORY 
  type: string
  default: "." # defaults for any parameters that specified with "." (current directory)

variables:
- name: RELEASE_COMMAND
  value: grep version ${{ parameters.DIRECTORY }}/package.json | awk -F \" '{print $4}'  

şablonu işlem hattınızda kullandığınızda, şablon parametreleri için değerleri belirtin.

# File: azure-pipelines.yml

variables: # Global variables
  - template: package-release-with-params.yml # Template reference
    parameters:
      DIRECTORY: "azure/checker"

pool:
  vmImage: 'ubuntu-latest'

stages:
- stage: Release_Stage 
  displayName: Release Version
  variables: # Stage variables
  - template: package-release-with-params.yml  # Template reference
    parameters:
      DIRECTORY: "azure/todo-list"
  jobs: 
  - job: A
    steps: 
    - bash: $(RELEASE_COMMAND) #output release command