Amazon CodeCatalyst tidak lagi terbuka untuk pelanggan baru. Pelanggan yang sudah ada dapat terus menggunakan layanan ini seperti biasa. Lihat informasi yang lebih lengkap di Cara bermigrasi dari CodeCatalyst.
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Membangun dan menguji tindakan YAML
Berikut ini adalah definisi YAML dari tindakan build dan test. Ada satu referensi untuk dua tindakan karena properti YAML mereka sangat mirip.
Definisi tindakan ini ada sebagai bagian dalam file definisi alur kerja yang lebih luas. Untuk informasi selengkapnya tentang file ini, lihatDefinisi YAML alur kerja.
Pilih properti YAML dalam kode berikut untuk melihat deskripsi jika itu.
catatan
Sebagian besar properti YAML berikut memiliki elemen UI yang sesuai di editor visual. Untuk mencari elemen UI, gunakan Ctrl+F. Elemen akan terdaftar dengan properti YAML terkait.
# The workflow definition starts here.
# See Top-level properti for details.
Name: MyWorkflow
SchemaVersion: 1.0
Actions:
# The action definition starts here.
action-name:
Identifier: aws/build@v1 | aws/managed-test@v1
DependsOn:
- dependent-action-name-1
Compute:
Type: EC2 | Lambda
Fleet: fleet-name
Timeout: timeout-minutes
Environment:
Name: environment-name
Connections:
- Name: account-connection-name
Role: iam-role-name
Caching:
FileCaching:
key-name-1:
Path: file1.txt
RestoreKeys:
- restore-key-1
Inputs:
Sources:
- source-name-1
- source-name-2
Artifacts:
- artifact-name
Variables:
- Name: variable-name-1
Value: variable-value-1
- Name: variable-name-2
Value: variable-value-2
Outputs:
Artifacts:
- Name: output-artifact-1
Files:
- build-output/artifact-1.jar
- "build-output/build*"
- Name: output-artifact-2
Files:
- build-output/artifact-2.1.jar
- build-output/artifact-2.2.jar
Variables:
- variable-name-1
- variable-name-2
AutoDiscoverReports:
Enabled: true | false
ReportNamePrefix: AutoDiscovered
IncludePaths:
- "**/*"
ExcludePaths:
- node_modules/cdk/junit.xml
SuccessCriteria:
PassRate: percent
LineCoverage: percent
BranchCoverage: percent
Vulnerabilities:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisBug:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisSecurity:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisQuality:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisFinding:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
Reports:
report-name-1:
Format: format
IncludePaths:
- "*.xml"
ExcludePaths:
- report2.xml
- report3.xml
SuccessCriteria:
PassRate: percent
LineCoverage: percent
BranchCoverage: percent
Vulnerabilities:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisBug:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisSecurity:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisQuality:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisFinding:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
Configuration:
Container:
Registry: registry
Image: image
Steps:
- Run: "step 1"
- Run: "step 2"
Packages:
NpmConfiguration:
PackageRegistries:
- PackagesRepository: package-repository
Scopes:
- "@scope"
ExportAuthorizationToken: true | false
aksi-nama
(Diperlukan)
Tentukan nama tindakan. Semua nama tindakan harus unik dalam alur kerja. Nama tindakan terbatas pada karakter alfanumerik (a-z,, 0-9) A-Z, tanda hubung (-), dan garis bawah (_). Spasi tidak diizinkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan karakter khusus dan spasi dalam nama tindakan.
UI yang sesuai: Tab konfigurasi/Nama T indakan
Pengidentifikasi
(action-name/Identifier)
Mengidentifikasi tindakan. Jangan mengubah properti ini kecuali Anda ingin mengubah versi. Untuk informasi selengkapnya, lihat Menentukan versi tindakan yang akan digunakan.
Gunakan aws/build@v1 untuk membangun tindakan.
Gunakan aws/managed-test@v1 untuk tindakan uji.
UI yang sesuai: Alur kerja diagram/Action -nama/label aws/build@v1|aws/managed-test@v1
DependsOn
(action-name/DependsOn)
(Opsional)
Tentukan tindakan, grup tindakan, atau gerbang yang harus berjalan dengan sukses agar tindakan ini dapat dijalankan.
Untuk informasi selengkapnya tentang fungsi 'tergantung pada', lihat. Tindakan sekuensing
UI yang sesuai: tab Input/Ter gantung pada - opsional
Hitung
(action-name/Compute)
(Opsional)
Mesin komputasi yang digunakan untuk menjalankan tindakan alur kerja Anda. Anda dapat menentukan komputasi baik di tingkat alur kerja atau pada tingkat tindakan, tetapi tidak keduanya. Ketika ditentukan pada tingkat alur kerja, konfigurasi komputasi berlaku untuk semua tindakan yang ditentukan dalam alur kerja. Pada tingkat alur kerja, Anda juga dapat menjalankan beberapa tindakan pada instance yang sama. Untuk informasi selengkapnya, lihat Berbagi komputasi di seluruh tindakan.
UI yang sesuai: tidak ada
Tipe
(action-name/Compute/Jenis)
(Diperlukan jika Hitung disertakan)
Jenis mesin komputasi. Anda dapat menggunakan salah satu nilai berikut:
-
EC2 (editor visual) atau
EC2(editor YAML)Dioptimalkan untuk fleksibilitas selama tindakan berjalan.
-
Lambda (editor visual) atau
Lambda(editor YAML)Kecepatan start-up aksi yang dioptimalkan.
Untuk informasi selengkapnya tentang jenis komputasi, lihatJenis komputasi.
UI yang sesuai: Tab konfigurasi/Jenis komputasi
Armada
(action-name/Compute/Fleet)
(Opsional)
Tentukan mesin atau armada yang akan menjalankan alur kerja atau tindakan alur kerja Anda. Dengan armada sesuai permintaan, ketika tindakan dimulai, alur kerja menyediakan sumber daya yang dibutuhkan, dan mesin dihancurkan ketika tindakan selesai. Contoh armada sesuai permintaan:Linux.x86-64.Large,Linux.x86-64.XLarge. Untuk informasi selengkapnya tentang armada sesuai permintaan, lihatOn-demand properti armada.
Dengan armada yang disediakan, Anda mengonfigurasi sekumpulan mesin khusus untuk menjalankan tindakan alur kerja Anda. Mesin-mesin ini tetap menganggur, siap untuk memproses tindakan segera. Untuk informasi selengkapnya tentang armada yang disediakan, lihat. Properti armada yang disediakan
Jika Fleet dihilangkan, defaultnya adalahLinux.x86-64.Large.
UI yang sesuai: Tab konfigurasi/Armada komputasi
Waktu habis
(action-name/Timeout)
(Opsional)
Tentukan jumlah waktu dalam menit (editor YAML), atau jam dan menit (editor visual), yang dapat dijalankan tindakan sebelum meng CodeCatalyst akhiri tindakan. Minimal adalah 5 menit dan maksimum dijelaskan dalamKuota untuk alur kerja di CodeCatalyst. Batas waktu default sama dengan batas waktu maksimum.
UI yang sesuai: tab konfigurasi/batas waktu - opsional
Lingkungan
(action-name/Environment)
(Opsional)
Tentukan CodeCatalyst lingkungan yang akan digunakan dengan tindakan. Tindakan terhubung ke Akun AWS dan opsional Amazon VPC yang ditentukan di lingkungan yang dipilih. Tindakan menggunakan peran IAM default yang ditentukan di lingkungan untuk terhubung ke Akun AWS, dan menggunakan peran IAM yang ditentukan dalam koneksi Amazon VPC untuk terhubung ke Amazon VPC.
catatan
Jika peran IAM default tidak memiliki izin yang diperlukan oleh tindakan, Anda dapat mengonfigurasi tindakan untuk menggunakan peran yang berbeda. Untuk informasi selengkapnya, lihat Mengubah peran IAM dari suatu tindakan.
Untuk informasi lebih lanjut tentang lingkungan, lihat Menyebarkan ke Akun AWS dan VPC danPembuatan lingkungan.
UI yang sesuai: Tab konfigurasi/Lingkungan
Nama
(action-name/Environment/Name)
(Opsional)
Tentukan nama lingkungan yang ada yang ingin Anda kaitkan dengan tindakan.
UI yang sesuai: Tab konfigurasi/Lingkungan
Koneksi
(action-name/Environment/Connections)
(Opsional)
Tentukan koneksi akun untuk dikaitkan dengan tindakan. Anda dapat menentukan maksimal satu koneksi akun di bawahEnvironment.
Jika Anda tidak menentukan koneksi akun:
-
Tindakan menggunakan Akun AWS koneksi dan peran IAM default yang ditentukan di lingkungan di CodeCatalyst konsol. Untuk informasi tentang menambahkan koneksi akun dan peran IAM default ke lingkungan, lihatPembuatan lingkungan.
-
Peran IAM default harus menyertakan kebijakan dan izin yang diperlukan oleh tindakan. Untuk menentukan kebijakan dan izin tersebut, lihat deskripsi properti Peran dalam dokumentasi definisi YAML tindakan.
Untuk informasi selengkapnya tentang koneksi akun, lihatMengizinkan akses ke AWS sumber daya dengan terhubung Akun AWS. Untuk informasi tentang menambahkan koneksi akun ke lingkungan, lihatPembuatan lingkungan.
UI yang sesuai: Konfigurasi tab/Environment /Apa yang ada di dalamnya? my-environment /menu tiga titik/Beralih peran
Nama
(action-name/Environment/Connections/Name)
(Diperlukan jika Koneksi disertakan)
Tentukan nama koneksi akun.
UI yang sesuai: Konfigurasi tab/Environment /Apa yang ada di dalamnya? my-environment /menu tiga titik/Beralih peran
Peran
(action-name/Environment/Connections/Role)
(Diperlukan jika Koneksi disertakan)
Tentukan nama peran IAM yang digunakan tindakan ini untuk mengakses dan beroperasi di AWS layanan seperti Amazon S3 dan Amazon ECR. Pastikan peran ini ditambahkan ke Akun AWS koneksi Anda di ruang Anda. Untuk menambahkan peran IAM ke koneksi akun, lihatMenambahkan peran IAM ke koneksi akun.
Jika Anda tidak menentukan peran IAM, tindakan tersebut menggunakan peran IAM default yang tercantum di lingkungan di CodeCatalyst konsol. Jika Anda menggunakan peran default di lingkungan, pastikan peran tersebut memiliki kebijakan berikut.
catatan
Anda dapat menggunakan CodeCatalystWorkflowDevelopmentRole- peran dengan tindakan ini. Untuk informasi selengkapnya tentang peran ini, silakan lihat Membuat CodeCatalystWorkflowDevelopmentRole-spaceNameperan untuk akun dan ruang Anda. Memahami bahwa spaceNameCodeCatalystWorkflowDevelopmentRole- peran tersebut memiliki izin akses penuh yang dapat menimbulkan risiko keamanan. Kami menyarankan Anda hanya menggunakan peran ini dalam tutorial dan skenario di mana keamanan kurang menjadi perhatian. spaceName
Awas
Batasi izin untuk yang diperlukan oleh tindakan build dan pengujian. Menggunakan peran dengan izin yang lebih luas dapat menimbulkan risiko keamanan.
UI yang sesuai: Konfigurasi tab/Environment /Apa yang ada di dalamnya? my-environment /menu tiga titik/Beralih peran
Pembuatan cache
(action-name/Caching)
(Opsional)
Bagian di mana Anda dapat menentukan cache untuk menyimpan file pada disk dan mengembalikannya dari cache tersebut dalam alur kerja berikutnya.
Untuk informasi selengkapnya tentang caching file, lihatCaching file antara alur kerja berjalan.
UI yang sesuai: Tab konfigurasi/ File caching - opsional
FileCaching
(action-name/Caching/FileCaching)
(Opsional)
Bagian yang menentukan konfigurasi untuk urutan cache.
UI yang sesuai: Konfigurasi tab/File caching - opsional/Tambahkan cache
nama-kunci-1
(action-name/Caching/FileCaching/key-name-1)
(Opsional)
Tentukan nama nama properti cache utama Anda. Nama properti cache harus unik dalam alur kerja Anda. Setiap tindakan dapat memiliki hingga lima entriFileCaching.
UI yang sesuai: Konfigurasi tab/File caching - optional/Add cache/Key
Jalur
(action-name/Caching/FileCaching/key-name-1/Path)
(Opsional)
Tentukan jalur terkait untuk cache Anda.
UI yang sesuai: Konfigurasi tab/File caching - optional/Add cac he/Path
RestoreKeys
(action-name/Caching/FileCaching/key-name-1/RestoreKeys)
(Opsional)
Tentukan kunci pemulihan untuk digunakan sebagai cadangan ketika properti cache utama tidak dapat ditemukan. Memulihkan nama kunci harus unik dalam alur kerja Anda. Setiap cache dapat memiliki hingga lima entriRestoreKeys.
UI yang sesuai: Konfigurasi tab/File cache - kunci optional/Add cache/ Restore - opsional
Masukan
(action-name/Inputs)
(Opsional)
InputsBagian ini mendefinisikan data yang diperlukan tindakan selama alur kerja dijalankan.
catatan
Maksimal empat input (satu sumber dan tiga artefak) diizinkan per tindakan build atau tindakan uji. Variabel tidak dihitung dalam total ini.
Jika Anda perlu merujuk ke file yang berada di input yang berbeda (katakanlah sumber dan artefak), input sumber adalah input utama, dan artefak adalah input sekunder. Referensi ke file dalam input sekunder mengambil awalan khusus untuk membedakannya dari primer. Lihat perinciannya di Contoh: Merujuk file dalam beberapa artefak.
UI yang sesuai: tab Input
Sumber
(action-name/Inputs/Sources)
(Opsional)
Tentukan label yang mewakili repositori sumber yang akan dibutuhkan oleh tindakan. Saat ini, satu-satunya label yang didukung adalahWorkflowSource, yang mewakili repositori sumber tempat file definisi alur kerja Anda disimpan.
Jika Anda menghilangkan sumber, maka Anda harus menentukan setidaknya satu artefak input di bawah. action-name/Inputs/Artifacts
Untuk informasi selengkapnya tentang sumber, lihat Menghubungkan repositori sumber ke alur kerja.
UI yang sesuai: tidak ada
Artefak - masukan
(action-name/Inputs/Artifacts)
(Opsional)
Tentukan artefak dari tindakan sebelumnya yang ingin Anda berikan sebagai masukan untuk tindakan ini. Artefak ini harus sudah didefinisikan sebagai artefak keluaran dalam tindakan sebelumnya.
Jika Anda tidak menentukan artefak input apa pun, maka Anda harus menentukan setidaknya satu repositori sumber di bawah.action-name/Inputs/Sources
Untuk informasi lebih lanjut tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.
catatan
Jika daftar drop-down Arti facts - opsional tidak tersedia (editor visual), atau jika Anda mendapatkan kesalahan saat memvalidasi YAML (editor YAML), itu mungkin karena tindakan hanya mendukung satu input. Dalam hal ini, coba hapus input sumber.
UI yang sesuai: tab Input/Ar tefak - opsional
Variabel - masukan
(action-name/Inputs/Variables)
(Opsional)
Tentukan urutan name/value pasangan yang menentukan variabel input yang ingin Anda sediakan untuk tindakan. Nama variabel terbatas pada karakter alfanumerik (a-z,, 0-9) A-Z, tanda hubung (-), dan garis bawah (_). Spasi tidak diizinkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan karakter khusus dan spasi dalam nama variabel.
Untuk informasi lebih lanjut tentang variabel, termasuk contoh, lihatMenggunakan variabel dalam alur kerja.
UI yang sesuai: Tab Input/ Variabel - opsional
Output
(action-name/Outputs)
(Opsional)
Mendefinisikan data yang dihasilkan oleh tindakan selama alur kerja dijalankan.
UI yang sesuai: tab Output
Artefak - keluaran
(action-name/Outputs/Artifacts)
(Opsional)
Tentukan nama artefak yang dihasilkan oleh tindakan. Nama artefak harus unik dalam alur kerja, dan terbatas pada karakter alfanumerik (a-z, A-Z, 0-9) dan garis bawah (_). Spasi, tanda hubung (-), dan karakter khusus lainnya tidak diperbolehkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan spasi, tanda hubung, dan karakter khusus lainnya dalam nama artefak keluaran.
Untuk informasi lebih lanjut tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.
UI yang sesuai: tab Output/Artefak
Nama
(action-name/Outputs/Artifacts/Name)
(Diperlukan jika Artefak - keluaran disertakan)
Tentukan nama artefak yang dihasilkan oleh tindakan. Nama artefak harus unik dalam alur kerja, dan terbatas pada karakter alfanumerik (a-z, A-Z, 0-9) dan garis bawah (_). Spasi, tanda hubung (-), dan karakter khusus lainnya tidak diperbolehkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan spasi, tanda hubung, dan karakter khusus lainnya dalam nama artefak keluaran.
Untuk informasi lebih lanjut tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.
UI yang sesuai: Output tab/Artifacts /Output baru/ Bangun nama artefak
Berkas
(action-name/Outputs/Artifacts/Files)
(Diperlukan jika Artefak - keluaran disertakan)
Tentukan file yang CodeCatalyst disertakan dalam artefak yang dikeluarkan oleh tindakan. File-file ini dihasilkan oleh tindakan alur kerja saat dijalankan, dan juga tersedia di repositori sumber Anda. Jalur file dapat berada di repositori sumber atau artefak dari tindakan sebelumnya, dan relatif terhadap repositori sumber atau root artefak. Anda dapat menggunakan pola glob untuk menentukan jalur. Contoh:
-
Untuk menentukan satu file yang ada di root lokasi build atau lokasi repositori sumber, gunakan
my-file.jar. -
Untuk menentukan satu file dalam subdirektori, gunakan
directory/my-file.jarataudirectory/subdirectory/my-file.jar. -
Untuk menentukan semua file, gunakan
"**/*". P**ola glob menunjukkan untuk mencocokkan sejumlah subdirektori. -
Untuk menentukan semua file dan direktori dalam direktori bernama
directory, gunakan"directory/**/*". P**ola glob menunjukkan untuk mencocokkan sejumlah subdirektori. -
Untuk menentukan semua file dalam direktori bernama
directory, tetapi tidak salah satu subdirektori, gunakan"directory/*".
catatan
Jika jalur file Anda menyertakan satu atau lebih tanda bintang (*) atau karakter khusus lainnya, lampirkan jalur dengan tanda kutip ganda (). "" Untuk informasi selengkapnya tentang karakter khusus, lihatPedoman dan konvensi sintaks.
Untuk informasi lebih lanjut tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.
catatan
Anda mungkin perlu menambahkan awalan ke jalur file untuk menunjukkan artefak atau sumber mana yang akan menemukannya. Untuk informasi selengkapnya, lihat Mereferensikan file repositori sumber dan Mereferensikan file dalam artefak.
UI yang sesuai: Output tab/Artifacts /Output baru/ File yang dihasilkan oleh build
Variabel - keluaran
(action-name/Outputs/Variables)
(Opsional)
Tentukan variabel yang ingin Anda ekspor tindakan sehingga tersedia untuk digunakan oleh tindakan selanjutnya.
Untuk informasi lebih lanjut tentang variabel, termasuk contoh, lihatMenggunakan variabel dalam alur kerja.
UI yang sesuai: Out tab/Variables put/ Tambahkan variabel
nama-variabel-1
(action-name/Outputs/Variables/variable-name-1)
(Opsional)
Tentukan nama variabel yang ingin Anda ekspor tindakan. Variabel ini harus sudah didefinisikan di Steps bagian Inputs atau dari tindakan yang sama.
Untuk informasi lebih lanjut tentang variabel, termasuk contoh, lihatMenggunakan variabel dalam alur kerja.
UI yang sesuai: Output tab/Variables /Tambahkan vari abel/Nama
AutoDiscoverReports
(action-name/Outputs/AutoDiscoverReports)
(Opsional)
Mendefinisikan konfigurasi untuk fitur penemuan otomatis.
Saat Anda mengaktifkan penemuan otomatis, semua CodeCatalyst pencarian Inputs diteruskan ke tindakan serta semua file yang dihasilkan oleh tindakan itu sendiri, mencari laporan pengujian, cakupan kode, dan analisis komposisi perangkat lunak (SCA). Untuk setiap laporan yang ditemukan CodeCatalyst , ubah menjadi CodeCatalyst laporan. CodeCatalyst Laporan adalah laporan yang sepenuhnya terintegrasi ke dalam CodeCatalyst layanan dan dapat dilihat dan dimanipulasi melalui CodeCatalyst konsol.
catatan
Secara default, fitur pencarian otomatis memeriksa semua file. Anda dapat membatasi file mana yang diperiksa menggunakan IncludePaths ExcludePaths properti atau.
UI yang sesuai: Output tab/Reports/Auto-discoverlaporan
Diaktifkan
(action-name/Outputs/AutoDiscoverReports/Enabled)
(Opsional)
Aktifkan atau menonaktifkan fitur penemuan otomatis.
Nilai-nilai yang valid adalah true atau false.
Jika Enabled dihilangkan, defaultnya adalahtrue.
UI yang sesuai: Output tab/Reports/Auto-discoverlaporan
ReportNamePrefix
(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)
(Diperlukan jika AutoDiscoverReports disertakan dan diaktifkan)
Tentukan awalan CodeCatalyst yang ditambahkan ke semua laporan yang ditemukannya untuk memberi nama laporan terkait CodeCatalyst . Misalnya, jika Anda menentukan awalanAutoDiscovered, dan CodeCatalyst menemukan dua laporan pengujian secara otomatis, TestSuiteOne.xml danTestSuiteTwo.xml, maka CodeCatalyst laporan terkait akan diberi nama AutoDiscoveredTestSuiteOne danAutoDiscoveredTestSuiteTwo.
UI yang sesuai: Output tab/Reports /Nama awalan
IncludePaths
(action-name/Outputs/AutoDiscoverReports/IncludePaths)
Atau
(action-name/Outputs/Reports/report-name-1/IncludePaths)
(Diperlukan jika AutoDiscoverReports disertakan dan diaktifkan, atau jika Laporan disertakan)
Tentukan file dan jalur file yang CodeCatalyst disertakan saat mencari laporan mentah. Misalnya, jika Anda menentukan "/test/report/*" CodeCatalyst , cari seluruh gambar build yang digunakan oleh tindakan mencari /test/report/* direktori. Ketika menemukan direktori itu, CodeCatalyst maka cari laporan di direktori itu.
catatan
Jika jalur file Anda menyertakan satu atau lebih tanda bintang (*) atau karakter khusus lainnya, lampirkan jalur dengan tanda kutip ganda (). "" Untuk informasi selengkapnya tentang karakter khusus, lihatPedoman dan konvensi sintaks.
Jika properti ini dihilangkan, defaultnya adalah"**/*", yang berarti pencarian mencakup semua file di semua jalur.
catatan
Untuk laporan yang dikonfigurasi secara manual, IncludePaths harus pola glob yang cocok dengan satu file.
UI yang sesuai:
-
Output Auto-discover reports/Include/ tab/Reports/mengecualikan jalur/ Sertakan jalur
-
Output tab/Reports /Konfigurasikan laporan secara manual// jalur
report-name-1/Sertakan Include/exclude jalur
ExcludePaths
(action-name/Outputs/AutoDiscoverReports/ExcludePaths)
Atau
(action-name/Outputs/Reports/report-name-1/ExcludePaths)
(Opsional)
Tentukan file dan jalur file yang dik CodeCatalyst ecualikan saat mencari laporan mentah. Misalnya, jika Anda menentukan"/test/my-reports/**/*", tidak CodeCatalyst akan mencari file di /test/my-reports/ direktori. Untuk mengabaikan semua file dalam direktori, gunakan pola **/* glob.
catatan
Jika jalur file Anda menyertakan satu atau lebih tanda bintang (*) atau karakter khusus lainnya, lampirkan jalur dengan tanda kutip ganda (). "" Untuk informasi selengkapnya tentang karakter khusus, lihatPedoman dan konvensi sintaks.
UI yang sesuai:
-
Output Auto-discover reports/Include //mengecualikan jalur tab/Reports/Kecualikan jalur
-
Output tab/Reports /Konfigurasikan laporan secara manual// jalur
report-name-1/Kecual Include/exclude ikan jalur
SuccessCriteria
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria)
(Opsional)
Tentukan kriteria keberhasilan untuk pengujian, cakupan kode, analisis komposisi perangkat lunak (SCA), dan analisis statis (SA) laporan.
Untuk informasi selengkapnya, lihat Mengkonfigurasi kriteria keberhasilan untuk laporan.
UI yang sesuai: Kriteria Out tab/Reports put/ Sukses
PassRate
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/PassRate)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/PassRate)
(Opsional)
Tentukan persentase pengujian dalam laporan pengujian yang harus lulus agar CodeCatalyst laporan terkait ditandai sebagai lulus. Nilai yang valid termasuk angka desimal. Misalnya: 50, 60.5. Kriteria tingkat kelulusan hanya diterapkan pada laporan pengujian. Untuk informasi lebih lanjut tentang laporan pengujian, lihatLaporan pengujian.
UI yang sesuai: Output/Krit tab/Reports eria sukses/Tingkat kelulusan
LineCoverage
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/LineCoverage)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/LineCoverage)
(Opsional)
Tentukan persentase baris dalam laporan cakupan kode yang harus dicakup agar CodeCatalyst laporan terkait ditandai sebagai lulus. Nilai yang valid termasuk angka desimal. Misalnya: 50, 60.5. Kriteria cakupan jalur hanya diterapkan pada laporan cakupan kode. Untuk informasi selengkapnya tentang laporan cakupan kode, lihatLaporan cakupan kode.
UI yang sesuai: Output tab/Reports /Kriteria sukses/cakupan jalur
BranchCoverage
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/BranchCoverage)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/BranchCoverage)
(Opsional)
Tentukan persentase cabang dalam laporan cakupan kode yang harus dicakup agar CodeCatalyst laporan terkait ditandai sebagai lulus. Nilai yang valid termasuk angka desimal. Misalnya: 50, 60.5. Kriteria cakupan cabang hanya diterapkan pada laporan cakupan kode. Untuk informasi selengkapnya tentang laporan cakupan kode, lihatLaporan cakupan kode.
UI yang sesuai: Output tab/Reports /kriteria sukses/cakupan cabang
Kerentanan
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/Vulnerabilities)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/Vulnerabilities)
(Opsional)
Tentukan jumlah maksimum dan tingkat keparahan kerentanan yang diizinkan dalam laporan SCA untuk CodeCatalyst laporan terkait yang akan ditandai sebagai lulus. Untuk menentukan kerentanan, Anda harus menentukan:
-
Tingkat keparahan minimum kerentanan yang ingin Anda sertakan dalam hitungan. Nilai yang valid, dari yang paling parah hingga yang paling tidak parah, adalah:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Misalnya, jika Anda memilih
HIGH, makaCRITICALkerHIGHentanan akan dihitung. -
Jumlah maksimum kerentanan dari tingkat keparahan tertentu yang Anda inginkan diizinkan. Melebihi angka ini menyebabkan CodeCatalyst laporan ditandai sebagai gagal. Nilai yang valid adalah bilangan bulat.
Kriteria kerentanan hanya diterapkan pada laporan SCA. Untuk informasi selengkapnya tentang laporan SCA, lihatLaporan analisis komposisi perangkat lunak.
Untuk menentukan tingkat keparahan minimum, gunakan Severity properti. Untuk menentukan jumlah kerentanan maksimum, gunakan Number properti.
UI yang sesuai: Output/kriteria tab/Reports sukses/Kerentanan
StaticAnalysisBug
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisBug)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisBug)
(Opsional)
Tentukan jumlah maksimum dan tingkat keparahan bug yang diizinkan dalam laporan SA untuk CodeCatalyst laporan terkait yang akan ditandai sebagai lulus. Untuk menentukan bug, Anda harus menentukan:
-
Tingkat keparahan minimum bug yang ingin Anda sertakan dalam hitungan. Nilai yang valid, dari yang paling parah hingga yang paling tidak parah, adalah:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Misalnya, jika Anda memilih
HIGH, makaHIGHCRITICALbug akan dihitung. -
Jumlah maksimum bug dari tingkat keparahan tertentu yang Anda inginkan diizinkan. Melebihi angka ini menyebabkan CodeCatalyst laporan ditandai sebagai gagal. Nilai yang valid adalah bilangan bulat.
Kriteria bug hanya diterapkan ke PyLint dan laporan ESLint SA. Untuk informasi selengkapnya tentang laporan SA, lihatLaporan analisis statis.
Untuk menentukan tingkat keparahan minimum, gunakan Severity properti. Untuk menentukan jumlah kerentanan maksimum, gunakan Number properti.
UI yang sesuai: Output/kriteria tab/Reports sukses/Bug
StaticAnalysisSecurity
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisSecurity)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisSecurity)
(Opsional)
Tentukan jumlah maksimum dan tingkat keparahan kerentanan keamanan yang diizinkan dalam laporan SA untuk CodeCatalyst laporan terkait yang akan ditandai sebagai lulus. Untuk menentukan kerentanan keamanan, Anda harus menentukan:
-
Tingkat keparahan minimum kerentanan keamanan yang ingin Anda sertakan dalam hitungan. Nilai yang valid, dari yang paling parah hingga yang paling tidak parah, adalah:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Misalnya, jika Anda memilih
HIGH, makaHIGHkerentananCRITICALkeamanan akan dihitung. -
Jumlah maksimum kerentanan keamanan dari tingkat keparahan tertentu yang ingin Anda izinkan. Melebihi angka ini menyebabkan CodeCatalyst laporan ditandai sebagai gagal. Nilai yang valid adalah bilangan bulat.
Kriteria kerentanan keamanan hanya diterapkan ke PyLint dan laporan ESLint SA. Untuk informasi selengkapnya tentang laporan SA, lihatLaporan analisis statis.
Untuk menentukan tingkat keparahan minimum, gunakan Severity properti. Untuk menentukan jumlah kerentanan maksimum, gunakan Number properti.
UI yang sesuai: Output/kriteria tab/Reports sukses/kerentanan keamanan
StaticAnalysisQuality
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisQuality)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisQuality)
(Opsional)
Tentukan jumlah maksimum dan tingkat keparahan masalah kualitas yang diizinkan dalam laporan SA untuk CodeCatalyst laporan terkait yang akan ditandai sebagai lulus. Untuk menentukan masalah kualitas, Anda harus menentukan:
-
Tingkat keparahan minimum masalah kualitas yang ingin Anda sertakan dalam hitungan. Nilai yang valid, dari yang paling parah hingga yang paling tidak parah, adalah:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Misalnya, jika Anda memilih
HIGH, makaHIGHmasalahCRITICALkualitas akan dihitung. -
Jumlah maksimum masalah kualitas dari tingkat keparahan tertentu yang Anda inginkan diizinkan. Melebihi angka ini menyebabkan CodeCatalyst laporan ditandai sebagai gagal. Nilai yang valid adalah bilangan bulat.
Kriteria masalah kualitas hanya diterapkan pada PyLint dan laporan ESLint SA. Untuk informasi selengkapnya tentang laporan SA, lihatLaporan analisis statis.
Untuk menentukan tingkat keparahan minimum, gunakan Severity properti. Untuk menentukan jumlah kerentanan maksimum, gunakan Number properti.
UI yang sesuai: Output tab/Reports /kriteria sukses/masalah kualitas
StaticAnalysisFinding
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisFinding)
Atau
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisFinding)
(Opsional)
Tentukan jumlah maksimum dan tingkat keparahan temuan yang diizinkan dalam laporan SA untuk CodeCatalyst laporan terkait yang akan ditandai sebagai lulus. Untuk menentukan temuan, Anda harus menentukan:
-
Tingkat keparahan minimum temuan yang ingin Anda sertakan dalam hitungan. Nilai yang valid, dari yang paling parah hingga yang paling tidak parah, adalah:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Misalnya, jika Anda memilih
HIGH, makaHIGHdanCRITICALtemuan akan dihitung. -
Jumlah maksimum temuan dari tingkat keparahan tertentu yang Anda inginkan diizinkan. Melebihi angka ini menyebabkan CodeCatalyst laporan ditandai sebagai gagal. Nilai yang valid adalah bilangan bulat.
Temuan hanya diterapkan pada laporan SARIF SA. Untuk informasi selengkapnya tentang laporan SA, lihatLaporan analisis statis.
Untuk menentukan tingkat keparahan minimum, gunakan Severity properti. Untuk menentukan jumlah kerentanan maksimum, gunakan Number properti.
UI yang sesuai: Output/kriteria tab/Reports sukses/Temuan
Laporan
(action-name/Outputs/Reports )
(Opsional)
Bagian yang menentukan konfigurasi untuk laporan pengujian.
UI yang sesuai: tab Output/Laporan
nama-laporan-1
(nam action-name /Outputs/Reports/ a-laporan-1)
(Diperlukan jika Laporan disertakan)
Nama yang ingin Anda berikan pada CodeCatalyst laporan yang akan dihasilkan dari laporan mentah Anda.
UI yang sesuai: Output tab/Reports /Konfigurasi laporan/Nama laporan secara manual/
Format
(action-name/Outputs/Reports/report-name-1/Format)
(Diperlukan jika Laporan disertakan)
Tentukan format file yang Anda gunakan untuk laporan Anda. Nilai yang mungkin adalah sebagai berikut.
-
Untuk laporan pengujian:
-
Untuk Cucumber JSON, tent ukan Cucumber (editor visual) atau
CUCUMBERJSON(editor YAML). -
Untuk JUnit XML, tentukan JUnit (editor visual) atau
JUNITXML(editor YAML). -
Untuk NUnit XML, tentukan nUnit (editor visual) atau
NUNITXML(editor YAML). -
Untuk NUnit 3 XML, tentukan nu Nit3 (editor visual) atau
NUNIT3XML(editor YAML). -
Untuk Visual Studio TRX, tentukan Visual Studio TRX (editor visual) atau
VISUALSTUDIOTRX(editor YAML). -
Untuk TestNG XML, tentukan TestNG (editor visual) atau
TESTNGXML(editor YAML).
-
-
Untuk laporan cakupan kode:
-
Untuk Clover XML, tent ukan Clover (editor visual) atau
CLOVERXML(editor YAML). -
Untuk Cobertura XML, tentukan Cobertura (editor visual) atau
COBERTURAXML(editor YAML). -
Untuk JaCoCo XML, tentukan JaCoCo (editor visual) atau
JACOCOXML(editor YAML). -
Untuk SimpleCov JSON yang dihasilkan oleh simplecov
, bukan simplec ov-json , tentukan S implecov (editor visual) atau (editor YAML). SIMPLECOV
-
-
Untuk laporan analisis komposisi perangkat lunak (SCA):
-
Untuk SARIF, tentukan SARIF (editor visual) atau
SARIFSCA(editor YAML).
-
UI yang sesuai: Output tab/Reports /Konfigurasikan secara manual reports/Add /konfigurasi laporanreport-name-1//Jenis laporan dan format laporan
Konfigurasi
(action-name/Configuration)
(Diperlukan) Bagian di mana Anda dapat menentukan properti konfigurasi tindakan.
UI yang sesuai: tab Konfigurasi
Kontainer
(action-name/Configuration/Container)
(Opsional)
Tentukan gambar Docker, atau wadah, yang digunakan tindakan untuk menyelesaikan prosesnya. Anda dapat menentukan salah satu gambar aktif yang disertakan CodeCatalyst, atau Anda dapat menggunakan gambar Anda sendiri. Jika Anda memilih untuk menggunakan gambar Anda sendiri, itu dapat berada di Amazon ECR, Docker Hub, atau registri lain. Jika Anda tidak menentukan image Docker, tindakan menggunakan salah satu gambar aktif untuk pemrosesan. Untuk informasi tentang gambar aktif mana yang digunakan secara default, lihatGambar aktif.
Untuk informasi selengkapnya tentang menentukan image Docker Anda sendiri, lihatMenetapkan image Docker lingkungan runtime kustom ke suatu tindakan.
UI yang sesuai: Lingkungan Runtime Docker image - opsional
Registri
(action-name/Configuration/Container/Registry)
(Diperlukan jika Container disertakan)
Tentukan registri tempat gambar Anda disimpan. Nilai yang valid meliputi:
-
CODECATALYST(Editor YAML)Gambar disimpan dalam CodeCatalyst registri.
-
Docker Hub (editor visual) atau
DockerHub(editor YAML)Gambar disimpan dalam registri gambar Docker Hub.
-
Registri lain (editor visual) atau
Other(editor YAML)Gambar disimpan dalam registri gambar kustom. Setiap registri yang tersedia untuk umum dapat digunakan.
-
Amazon Elastic Container Registry (editor visual) atau
ECR(editor YAML)Gambar disimpan dalam repositori gambar Amazon Elastic Container Registry. Untuk menggunakan gambar di repositori Amazon ECR, tindakan ini memerlukan akses ke Amazon ECR. Untuk mengaktifkan akses ini, Anda harus membuat peran IAM yang menyertakan izin berikut dan kebijakan kepercayaan khusus. (Anda dapat mengubah peran yang ada untuk menyertakan izin dan kebijakan, jika Anda mau.)
Peran IAM harus menyertakan izin berikut dalam kebijakan perannya:
-
ecr:BatchCheckLayerAvailability -
ecr:BatchGetImage -
ecr:GetAuthorizationToken -
ecr:GetDownloadUrlForLayer
Peran IAM harus menyertakan kebijakan kepercayaan kustom berikut:
Untuk informasi selengkapnya tentang membuat peran IAM, lihat Membuat peran menggunakan kebijakan kepercayaan khusus (konsol) di Panduan Pengguna IAM.
Setelah Anda membuat peran, Anda harus menetapkannya ke tindakan melalui lingkungan. Untuk informasi selengkapnya, lihat Mengaitkan lingkungan dengan tindakan.
-
UI yang sesuai: Amazon Elastic Container Registry, Docker Hub, dan opsi registr i lainnya
Citra
(action-name/Configuration/Container/Image)
(Diperlukan jika Container disertakan)
Tentukan satu dari yang berikut ini:
-
Jika Anda menggunakan
CODECATALYSTregistri, atur gambar ke salah satu gambar aktif berikut:-
CodeCatalystLinux_x86_64:2024_03 -
CodeCatalystLinux_x86_64:2022_11 -
CodeCatalystLinux_Arm64:2024_03 -
CodeCatalystLinux_Arm64:2022_11 -
CodeCatalystLinuxLambda_x86_64:2024_03 -
CodeCatalystLinuxLambda_x86_64:2022_11 -
CodeCatalystLinuxLambda_Arm64:2024_03 -
CodeCatalystLinuxLambda_Arm64:2022_11 -
CodeCatalystWindows_x86_64:2022_11
-
-
Jika Anda menggunakan registri Docker Hub, atur gambar ke nama gambar Docker Hub dan tag opsional.
Contoh:
postgres:latest -
Jika Anda menggunakan registri Amazon ECR, atur gambar ke URI registri Amazon ECR.
Contoh:
111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo -
Jika Anda menggunakan registri kustom, atur gambar ke nilai yang diharapkan oleh registri kustom.
UI yang sesuai: Gambar docker lingkungan Runtime (jika registri adaCODECATALYST), gambar Docker Hub (jika registri adalah Docker Hub), URL gambar ECR (jika registri adalah Amazon Elastic Container Registry), dan URL Gambar (jika registri adalah Registry Lainnya).
Langkah-langkah
(action-name/Configuration/Steps)
(Diperlukan)
Tentukan perintah shell yang ingin Anda jalankan selama tindakan untuk menginstal, mengkonfigurasi, dan menjalankan alat build Anda.
Berikut adalah contoh cara membangun proyek npm:
Steps:
- Run: npm install
- Run: npm run build
Berikut adalah contoh cara menentukan jalur file:
Steps:
- Run: cd $ACTION_BUILD_SOURCE_PATH_WorkflowSource/app && cat file2.txt
- Run: cd $ACTION_BUILD_SOURCE_PATH_MyBuildArtifact/build-output/ && cat file.txt
Untuk informasi selengkapnya tentang menentukan jalur file, lihat Mereferensikan file repositori sumber danMereferensikan file dalam artefak.
UI yang sesuai: Tab konfigurasi/perintah Shell
Paket
(action-name/Configuration/Packages)
(Opsional)
Bagian di mana Anda dapat menentukan repositori paket yang digunakan tindakan untuk menyelesaikan dependensi. Paket memungkinkan Anda untuk menyimpan dan berbagi paket perangkat lunak yang digunakan untuk pengembangan aplikasi dengan aman.
Untuk informasi selengkapnya tentang paket, lihatPublikasikan dan bagikan paket perangkat lunak di CodeCatalyst.
UI yang sesuai: Tab konfigurasi/Paket
NpmConfiguration
(action-name/Configuration/Packages/NpmConfiguration)
(Diperlukan jika Paket disertakan)
Bagian yang mendefinisikan konfigurasi untuk format paket npm. Konfigurasi ini digunakan oleh tindakan selama alur kerja dijalankan.
Untuk informasi selengkapnya tentang konfigurasi paket npm, lihatMenggunakan npm.
UI yang sesuai: Konfigurasi tab/Packages /Tambahkan konfigurasi/npm
PackageRegistries
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries)
(Diperlukan jika Paket disertakan)
Bagian di mana Anda dapat menentukan properti konfigurasi dari urutan repositori paket.
UI yang sesuai: Konfigurasi tab/Packages /Tambah configuration/npm/Tambahkan repositori paket
PackagesRepository
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/PackagesRepository)
(Diperlukan jika Paket disertakan)
Tentukan nama repositori CodeCatalyst paket Anda yang ingin tindakan digunakan.
Jika Anda menentukan beberapa repositori default, repositori terakhir akan diprioritaskan.
Untuk informasi selengkapnya tentang repositori paket, lihatRepositori paket.
UI yang sesuai: Konfigurasi tab/Packages /Tambah/Tambahkan repositori paket configuration/npm /repositori paket
Cakupan
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/Scopes)
(Opsional)
Tentukan urutan cak upan yang ingin Anda tentukan dalam registri paket Anda. Saat mendefinisikan cakupan, repositori paket yang ditentukan dikonfigurasi sebagai registri untuk semua cakupan yang terdaftar. Jika paket dengan cakupan diminta melalui klien npm, itu akan menggunakan repositori itu alih-alih default. Setiap nama cakupan harus diawali dengan “@”.
Jika Anda menyertakan cakupan penggantian, repositori terakhir akan diprioritaskan.
Jika Scopes dihilangkan, maka repositori paket yang ditentukan dikonfigurasi sebagai registri default untuk semua paket yang digunakan oleh tindakan.
Untuk informasi selengkapnya tentang cakupan, lihat Ruang nama paket dan Paket https://docs.npmjs.com/cli/v10/using-npm/scope
UI yang sesuai: Konfigurasi tab/Packages /Tambah/Tambahkan repositori paket configuration/npm /Cakupan - opsional
ExportAuthorizationToken
(action-name/Configuration/Packages/ExportAuthorizationToken)
(Opsional)
Mengaktifkan atau menonaktifkan fitur token otorisasi ekspor. Jika diaktifkan, token otorisasi yang diekspor dapat digunakan untuk mengonfigurasi pengelola paket secara manual agar diautentikasi dengan repositori CodeCatalyst paket. Anda dapat menggunakan token sebagai variabel lingkungan yang dapat direferensikan dalam tindakan Anda.
Nilai-nilai yang valid adalah true atau false.
Jika ExportAuthorizationToken dihilangkan, defaultnya adalahfalse.
Untuk informasi selengkapnya tentang token otorisasi ekspor, lihatMenggunakan token otorisasi dalam tindakan alur kerja.
UI yang sesuai: Konfigurasi tab/Packages /token otorisasi ekspor