Referensi skema YAML untuk Azure Pipelines

Referensi skema YAML untuk Azure Pipelines adalah referensi terperinci untuk alur YAML yang mencantumkan semua sintaks YAML yang didukung dan opsi yang tersedia.

Untuk membuat alur YAML, mulailah dengan definisi alur . Untuk informasi selengkapnya tentang membangun alur YAML, lihat Menyesuaikan alur Anda.

Referensi skema YAML tidak mencakup tugas. Untuk informasi selengkapnya tentang tugas, lihat indeks tugas Azure Pipelines.

Definisi

Pipa
Alur adalah satu atau beberapa tahap yang menjelaskan proses CI/CD. Definisi alur berisi dokumentasi untuk properti tingkat akar seperti name.

Meluas
Memperluas alur menggunakan templat.

Pekerjaan
Menentukan pekerjaan yang membentuk pekerjaan tahapan.

jobs.deployment
Pekerjaan penyebaran adalah jenis pekerjaan khusus. Ini adalah kumpulan langkah-langkah untuk berjalan secara berurutan terhadap lingkungan.

jobs.deployment.environment
Menargetkan nama lingkungan dan secara opsional nama sumber daya untuk merekam riwayat penyebaran; format: environment-name.resource-name.

jobs.deployment.strategy
Strategi eksekusi untuk penyebaran ini.

jobs.deployment.strategy.canary
Strategi Penyebaran Kenari.

jobs.deployment.strategy.rolling
Strategi Penyebaran Bergulir.

jobs.deployment.strategy.runOnce
Strategi Penyebaran RunOnce.

jobs.job
Pekerjaan adalah kumpulan langkah yang dijalankan oleh agen atau di server.

jobs.job.container
Nama sumber daya kontainer.

jobs.job.strategy
Strategi eksekusi untuk pekerjaan ini.

jobs.job.uses
Sumber daya apa pun yang diperlukan oleh pekerjaan ini yang belum dirujuk.

jobs.template
Sekumpulan pekerjaan yang ditentukan dalam templat.

Parameter
Menentukan parameter runtime yang diteruskan ke alur.

parameters.parameter
Parameter templat alur.

Renang
Kumpulan mana yang akan digunakan untuk pekerjaan alur.

pool.demands
Tuntutan (untuk kumpulan privat).

Pr
Pemicu permintaan pull.

Sumber daya
Sumber daya menentukan build, repositori, alur, dan sumber daya lain yang digunakan oleh alur.

resources.builds
Daftar sumber daya build yang dirujuk oleh alur.

resources.builds.build
Sumber daya build yang digunakan untuk mereferensikan artefak dari eksekusi.

resources.containers
Daftar gambar kontainer.

resources.containers.container
Sumber daya kontainer yang digunakan untuk mereferensikan gambar kontainer.

resources.containers.container.trigger
Tentukan tidak ada yang akan dinonaktifkan, true untuk memicu pada semua tag gambar, atau gunakan sintaks lengkap seperti yang dijelaskan dalam contoh berikut.

resources.packages
Daftar sumber daya paket.

resources.packages.package
Sumber daya paket yang digunakan untuk mereferensikan paket GitHub NuGet atau npm.

resources.pipelines
Daftar sumber daya alur.

resources.pipelines.pipeline
Sumber daya alur.

resources.pipelines.pipeline.trigger
Tentukan tidak ada yang akan dinonaktifkan, benar untuk menyertakan semua cabang, atau gunakan sintaks lengkap seperti yang dijelaskan dalam contoh berikut.

resources.pipelines.pipeline.trigger.branches
Cabang yang akan disertakan atau dikecualikan untuk memicu eksekusi.

resources.repositories
Daftar sumber daya repositori.

resources.repositories.repository
Sumber daya repositori digunakan untuk mereferensikan repositori tambahan di alur Anda.

resources.webhooks
Daftar webhook.

resources.webhooks.webhook
Sumber daya webhook memungkinkan Anda mengintegrasikan alur Anda dengan layanan eksternal untuk mengotomatiskan alur kerja.

resources.webhooks.webhook.filters
Daftar filter pemicu.

resources.webhooks.webhook.filters.filter
Filter pemicu sumber daya webhook.

jadwal
Daftar jadwal menentukan pemicu terjadwal untuk alur.

schedules.cron
Pemicu terjadwal menentukan jadwal di mana cabang dibangun.

Tahap
Tahapan adalah kumpulan pekerjaan terkait.

stages.stage
Tahap adalah kumpulan pekerjaan terkait.

stages.template
Anda dapat menentukan serangkaian tahapan dalam satu file dan menggunakannya beberapa kali di file lain.

Langkah
Langkah-langkah adalah urutan operasi linier yang membentuk pekerjaan.

steps.bash
Menjalankan skrip di Bash di Windows, macOS, dan Linux.

steps.checkout
Konfigurasikan cara alur memeriksa kode sumber.

steps.download
Mengunduh artefak yang terkait dengan eksekusi saat ini atau dari Azure Pipeline lain yang terkait dengan sumber daya alur.

steps.downloadBuild
Mengunduh artefak build.

steps.getPackage
Mengunduh paket dari umpan manajemen paket di Azure Artifacts atau Azure DevOps Server.

steps.powershell
Menjalankan skrip menggunakan Windows PowerShell (di Windows) atau pwsh (Linux dan macOS).

steps.publish
Menerbitkan (mengunggah) file atau folder sebagai artefak alur yang dapat dikonsumsi oleh pekerjaan dan alur lain.

steps.pwsh
Menjalankan skrip di PowerShell Core di Windows, macOS, dan Linux.

steps.reviewApp
Unduhan membuat sumber daya secara dinamis di bawah penyedia fase penyebaran.

steps.script
Menjalankan skrip menggunakan cmd.exe di Windows dan Bash pada platform lain.

steps.task
Menjalankan tugas.

steps.template
Tentukan serangkaian langkah dalam satu file dan gunakan beberapa kali dalam file lain.

Target
Tugas berjalan dalam konteks eksekusi, yang merupakan host agen atau kontainer.

target.settableVariables
Pembatasan variabel mana yang dapat diatur.

Memicu
Pemicu integrasi berkelanjutan (dorong).

Variabel
Tentukan variabel menggunakan pasangan nama/nilai.

variables.group
Variabel referensi dari grup variabel.

variables.name
Tentukan variabel menggunakan nama dan sintaks penuh.

variables.template
Tentukan variabel dalam templat.

Definisi pendukung

Catatan

Definisi pendukung tidak dimaksudkan untuk digunakan langsung dalam alur. Definisi pendukung hanya digunakan sebagai bagian dari definisi lain, dan disertakan di sini untuk referensi.

deployHook
Digunakan untuk menjalankan langkah-langkah yang menyebarkan aplikasi Anda.

includeExcludeFilters
Daftar item yang akan disertakan atau dikecualikan.

includeExcludeStringFilters
Item yang akan disertakan atau dikecualikan.

mountReadOnly
Volume untuk memasang baca-saja, defaultnya adalah false.

onFailureHook
Digunakan untuk menjalankan langkah-langkah untuk tindakan putar kembali atau pembersihan.

onSuccessHook
Digunakan untuk menjalankan langkah-langkah untuk tindakan putar kembali atau pembersihan.

onSuccessOrFailureHook
Digunakan untuk menjalankan langkah-langkah untuk tindakan putar kembali atau pembersihan.

postRouteTrafficHook
Digunakan untuk menjalankan langkah-langkah setelah lalu lintas dirutekan. Biasanya, tugas-tugas ini memantau kesehatan versi yang diperbarui untuk interval yang ditentukan.

preDeployHook
Digunakan untuk menjalankan langkah-langkah yang menginisialisasi sumber daya sebelum penyebaran aplikasi dimulai.

routeTrafficHook
Digunakan untuk menjalankan langkah-langkah yang melayani lalu lintas ke versi yang diperbarui.

Workspace
Opsi ruang kerja pada agen.

Konvensi dokumentasi skema YAML

Referensi skema YAML adalah panduan referensi terperinci untuk alur YAML Azure Pipelines. Ini termasuk katalog semua kemampuan YAML yang didukung dan opsi yang tersedia.

Berikut adalah konvensi sintaksis yang digunakan dalam referensi skema YAML.

• Di sebelah kiri : adalah kata kunci harfiah yang digunakan dalam definisi alur.
• Di sebelah kanan : adalah jenis data. Jenis data dapat menjadi jenis primitif seperti string atau referensi ke struktur kaya yang ditentukan di tempat lain dalam referensi ini.
• Jenis data] notasi [ menunjukkan array dari jenis definisi yang disebutkan. Misalnya, [ string ] adalah array string.
• Jenisdata}jenis data: notasi { menunjukkan pemetaan satu jenis data ke jenis data lainnya. Misalnya, { string: string } adalah pemetaan string ke string.
• Simbol | menunjukkan ada beberapa jenis data yang tersedia untuk kata kunci. Misalnya, job | template berarti definisi kerja atau referensi templat diizinkan.

Lihat juga

Referensi ini mencakup skema file YAML Azure Pipelines. Untuk mempelajari dasar-dasar YAML, lihat Pelajari YAML dalam Y Minutes. Azure Pipelines tidak mendukung semua fitur YAML. Fitur yang tidak didukung termasuk jangkar, kunci kompleks, dan set. Selain itu, tidak seperti YAML standar, Azure Pipelines bergantung pada melihat stage, , taskjob, atau pintasan tugas seperti script sebagai kunci pertama dalam pemetaan.