Tindakan 'GitHub Tindakan' YAML

Berikut ini adalah YAML definisi GitHubtindakan Tindakan.

Definisi tindakan ini ada sebagai bagian dalam file definisi alur kerja yang lebih luas. Untuk informasi selengkapnya tentang file ini, lihatDefinisi alur kerja YAML.

Pilih YAML properti dalam kode berikut untuk melihat deskripsi jika itu.

catatan

Sebagian besar YAML properti yang mengikuti memiliki elemen UI yang sesuai di editor visual. Untuk mencari elemen UI, gunakan Ctrl+F. Elemen akan terdaftar dengan YAML properti terkait.


# The workflow definition starts here.
# See Properti tingkat atas for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.
  action-name:
    Identifier:  aws/github-actions-runner@v1
    DependsOn:
      - dependent-action-name-1
    Compute:
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    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: 
            - github-output/artifact-1.jar
            - "github-output/build*"
        - Name: output-artifact-2
          Files:
            - github-output/artifact-2.1.jar
            - github-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
      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
    Configuration      
      Steps:
        - github-actions-code

nama-tindakan

(Diperlukan)

Tentukan nama tindakan. Semua nama tindakan harus unik dalam alur kerja. Nama aksi terbatas pada karakter alfanumerik (a-z, A-Z, 0-9), tanda hubung (-), dan garis bawah (_). Spasi tidak diizinkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan karakter dan spasi khusus dalam nama tindakan.

UI yang sesuai: Tab konfigurasi/action-name

Identifier

(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/github-actions-runner@v1 untuk GitHubtindakan tindakan.

UI yang sesuai: Diagram alur kerja/action-name/aws/ @v1 label github-actions-runner

DependsOn

(action-name/DependsOn)

(Opsional)

Tentukan tindakan, grup tindakan, atau gerbang yang harus berjalan dengan sukses agar tindakan ini berjalan.

Untuk informasi selengkapnya tentang fungsionalitas 'tergantung pada', lihat. Tindakan pengurutan

UI yang sesuai: Tab masukan/Tergantung pada - opsional

Compute

(action-name/Compute)

(Opsional)

Mesin komputasi yang digunakan untuk menjalankan tindakan alur kerja Anda. Anda dapat menentukan komputasi baik di tingkat alur kerja atau di 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

Fleet

(action-name/Compute/Fleet)

(Opsional)

Tentukan mesin atau armada yang akan menjalankan alur kerja atau tindakan alur kerja Anda. Dengan armada sesuai permintaan, ketika suatu 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 lebih lanjut tentang armada sesuai permintaan, lihat. Properti armada sesuai permintaan

Dengan armada yang disediakan, Anda mengonfigurasi satu set 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 adalah. Linux.x86-64.Large

UI yang sesuai: Tab konfigurasi/Armada komputasi - opsional

Timeout

(action-name/Timeout)

(Opsional)

Tentukan jumlah waktu dalam menit (YAMLeditor), atau jam dan menit (editor visual), bahwa tindakan dapat berjalan sebelum CodeCatalyst mengakhiri 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/Timeout - opsional

Environment

(action-name/Environment)

(Opsional)

Tentukan CodeCatalyst lingkungan yang akan digunakan dengan tindakan. Tindakan terhubung ke Amazon Akun AWS dan opsional VPC yang ditentukan di lingkungan yang dipilih. Tindakan menggunakan IAM peran default yang ditentukan di lingkungan untuk terhubung ke Akun AWS, dan menggunakan IAM peran yang ditentukan dalam VPCkoneksi Amazon untuk terhubung ke AmazonVPC.

catatan

Jika IAM peran default tidak memiliki izin yang diperlukan oleh tindakan, Anda dapat mengonfigurasi tindakan untuk menggunakan peran yang berbeda. Untuk informasi selengkapnya, lihat Mengubah IAM peran suatu tindakan.

Untuk informasi lebih lanjut tentang lingkungan, lihat Menyebarkan ke Akun AWS dan VPCs danPembuatan lingkungan.

UI yang sesuai: Tab konfigurasi/Lingkungan

Name

(action-name/Environment/Name)

(Diperlukan Environment jika disertakan)

Tentukan nama lingkungan yang ada yang ingin Anda kaitkan dengan tindakan.

UI yang sesuai: Tab konfigurasi/Lingkungan

Connections

(action-name/Environment/Connections)

(Opsional)

Tentukan koneksi akun untuk dikaitkan dengan tindakan. Anda dapat menentukan maksimum satu koneksi akun di bawahEnvironment.

Jika Anda tidak menentukan koneksi akun:

Tindakan menggunakan Akun AWS koneksi dan IAM peran default yang ditentukan di lingkungan di CodeCatalyst konsol. Untuk informasi tentang menambahkan koneksi akun dan IAM peran default ke lingkungan, lihatPembuatan lingkungan.
IAMPeran default harus menyertakan kebijakan dan izin yang diperlukan oleh tindakan. Untuk menentukan kebijakan dan izin tersebut, lihat deskripsi properti Peran dalam dokumentasi YAML definisi tindakan.

Untuk informasi selengkapnya tentang koneksi akun, lihatMemungkinkan akses ke AWS sumber daya yang terhubung Akun AWS. Untuk informasi tentang menambahkan koneksi akun ke lingkungan, lihatPembuatan lingkungan.

UI yang sesuai: Tab konfigurasi/Lingkungan/Apa yang ada my-environment? /menu tiga titik/Beralih peran

Name

(action-name/Environment/Connections/Name)

(Diperlukan Connections jika disertakan)

Tentukan nama koneksi akun.

UI yang sesuai: Tab konfigurasi/Lingkungan/Apa yang ada my-environment? /menu tiga titik/Beralih peran

Role

(action-name/Environment/Connections/Role)

(Diperlukan Connections jika disertakan)

Tentukan nama IAM peran 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 IAM peran ke koneksi akun, lihatMenambahkan IAM peran ke koneksi akun.

Jika Anda tidak menentukan IAM peran, maka tindakan tersebut menggunakan IAM peran default yang tercantum di lingkungan di CodeCatalyst konsol. Jika Anda menggunakan peran default di lingkungan, pastikan itu memiliki kebijakan berikut.

catatan

Anda dapat menggunakan CodeCatalystWorkflowDevelopmentRole-spaceName peran dengan tindakan ini. Untuk informasi selengkapnya tentang peran ini, silakan lihat Membuat CodeCatalystWorkflowDevelopmentRole-spaceNameperan untuk akun dan ruang Anda. Memahami bahwa CodeCatalystWorkflowDevelopmentRole-spaceName 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.

Awas

Batasi izin untuk yang diperlukan oleh GitHub tindakan Tindakan. Menggunakan peran dengan izin yang lebih luas dapat menimbulkan risiko keamanan.

UI yang sesuai: Tab konfigurasi/Lingkungan/Apa yang ada my-environment? /menu tiga titik/Beralih peran

Inputs

(action-name/Inputs)

(Opsional)

InputsBagian ini mendefinisikan data yang dibutuhkan tindakan selama menjalankan alur kerja.

catatan

Maksimal empat input (satu sumber dan tiga artefak) diperbolehkan per GitHub tindakan Tindakan. Variabel tidak dihitung terhadap 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 menyisihkannya dari primer. Lihat perinciannya di Contoh: Merujuk file dalam beberapa artefak.

UI yang sesuai: Tab input

Sources

(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: Tab/Sumber Input - opsional

Artifacts - input

(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 selengkapnya tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.

catatan

Jika Artefacts - daftar drop-down opsional tidak tersedia (editor visual), atau jika Anda mendapatkan kesalahan saat Anda memvalidasi YAML (YAMLeditor) Anda, itu mungkin karena tindakan hanya mendukung satu input. Dalam hal ini, coba hapus input sumber.

UI yang sesuai: Input tab/Artefak - opsional

Variables - input

(action-name/Inputs/Variables)

(Opsional)

Tentukan urutan pasangan nama/nilai yang menentukan variabel input yang ingin Anda sediakan untuk tindakan. Nama variabel terbatas pada karakter alfanumerik (a-z, A-Z, 0-9), tanda hubung (-), dan garis bawah (_). Spasi tidak diizinkan. Anda tidak dapat menggunakan tanda kutip untuk mengaktifkan karakter dan spasi khusus dalam nama variabel.

Untuk informasi selengkapnya tentang variabel, termasuk contoh, lihatMenggunakan variabel dalam alur kerja.

UI yang sesuai: Input tab/Variabel - opsional

Outputs

(action-name/Outputs)

(Opsional)

Mendefinisikan data yang dihasilkan oleh tindakan selama menjalankan alur kerja.

UI yang sesuai: Tab keluaran

Artifacts - output

(action-name/Outputs/Artifacts)

(Opsional)

Tentukan nama artefak yang dihasilkan oleh tindakan. Nama artifak 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 selengkapnya tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.

UI yang sesuai: Tab keluaran/Artefak

Name

(action-name/Outputs/Artifacts/Name)

(Diperlukan Artifacts - output jika disertakan)

Untuk informasi selengkapnya tentang artefak, termasuk contoh, lihatBerbagi artefak dan file antar tindakan.

UI yang sesuai: Tab Keluaran/Artefak/Tambahkan artefak/Bangun nama artefak

Files

(action-name/Outputs/Artifacts/Files)

(Diperlukan Artifacts - output jika disertakan)

Tentukan file yang CodeCatalyst termasuk dalam artefak yang dihasilkan 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.jar ataudirectory/subdirectory/my-file.jar.
Untuk menentukan semua file, gunakan"**/*". Pola ** glob menunjukkan untuk mencocokkan sejumlah subdirektori.
Untuk menentukan semua file dan direktori dalam direktori bernamadirectory, gunakan"directory/**/*". Pola ** glob menunjukkan untuk mencocokkan sejumlah subdirektori.
Untuk menentukan semua file dalam direktori bernamadirectory, tetapi tidak salah satu subdirektorinya, gunakan. "directory/*"

catatan

Jika jalur file Anda menyertakan satu atau beberapa tanda bintang (*) atau karakter khusus lainnya, lampirkan jalur dengan tanda kutip ganda (). "" Untuk informasi selengkapnya tentang karakter khusus, lihatPedoman dan konvensi sintaks.

Untuk informasi selengkapnya 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 Merujuk file repositori sumber dan Merujuk file dalam artefak.

UI yang sesuai: Tab Keluaran/Artefak/Tambahkan artefak/File yang dihasilkan oleh build

Variables - output

(action-name/Outputs/Variables)

(Opsional)

Tentukan variabel yang ingin Anda ekspor tindakan sehingga tersedia untuk digunakan oleh tindakan selanjutnya.

Untuk informasi selengkapnya tentang variabel, termasuk contoh, lihatMenggunakan variabel dalam alur kerja.

UI yang sesuai: Tab keluaran/Variabel/Tambahkan variabel

variabel-nama-1

(action-name/Outputs/Variablesvariabel-nama-1)

(Opsional)

Tentukan nama variabel yang ingin Anda ekspor tindakan. Variabel ini harus sudah didefinisikan dalam Inputs atau Steps bagian dari tindakan yang sama.

Untuk informasi selengkapnya tentang variabel, termasuk contoh, lihatMenggunakan variabel dalam alur kerja.

UI yang sesuai: Tab keluaran/variabel/Tambahkan variabel/Nama

AutoDiscoverReports

(action-name/Outputs/AutoDiscoverReports)

(Opsional)

Mendefinisikan konfigurasi untuk fitur auto-discovery.

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 mengubahnya 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 auto-discover memeriksa semua file. Anda dapat membatasi file mana yang diperiksa menggunakan ExcludePaths properti IncludePaths atau.

UI yang sesuai: tidak ada

Enabled

(action-name/Outputs/AutoDiscoverReports/Enabled)

(Opsional)

Aktifkan atau nonaktifkan fitur penemuan otomatis.

Nilai-nilai yang valid adalah true atau false.

Jika Enabled dihilangkan, defaultnya adalah. true

UI yang sesuai: Tab Keluaran/Laporan/Secara otomatis menemukan laporan

ReportNamePrefix

(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)

(Diperlukan AutoDiscoverReports jika disertakan dan diaktifkan)

Tentukan CodeCatalyst awalan yang ditambahkan ke semua laporan yang ditemukannya untuk memberi nama laporan terkait. CodeCatalyst Misalnya, jika Anda menentukan awalanAutoDiscovered, dan CodeCatalyst otomatis menemukan dua laporan pengujian, TestSuiteOne.xml danTestSuiteTwo.xml, maka CodeCatalyst laporan terkait akan diberi nama dan. AutoDiscoveredTestSuiteOne AutoDiscoveredTestSuiteTwo

UI yang sesuai: Tab Keluaran/Laporan/Secara otomatis menemukan laporan/Awalan laporan

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

Atau

(action-name/Outputs/Reports/report-name-1/IncludePaths)

(Diperlukan jika AutoDiscoverReports disertakan dan diaktifkan, atau Reports jika disertakan)

Tentukan file dan jalur file yang CodeCatalyst disertakan saat mencari laporan mentah. Misalnya, jika Anda menentukan"/test/report/*", akan CodeCatalyst mencari seluruh image build yang digunakan oleh tindakan mencari /test/report/* direktori. Ketika menemukan direktori itu, CodeCatalyst maka cari laporan di direktori itu.

catatan

Jika properti ini dihilangkan, defaultnya adalah"**/*", artinya pencarian mencakup semua file di semua jalur.

catatan

Untuk laporan yang dikonfigurasi secara manual, IncludePaths harus berupa pola glob yang cocok dengan satu file.

UI yang sesuai:

Tab keluaran/Laporan/Secara otomatis menemukan laporan/'Sertakan/Kecualikan jalur'/ Sertakan jalur
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/'Sertakan/kecualikan jalur'/ Sertakan jalur

ExcludePaths

(action-name/Outputs/AutoDiscoverReports/ExcludePaths)

Atau

(action-name/Outputs/Reports/report-name-1/ExcludePaths)

(Opsional)

Tentukan file dan jalur file yang CodeCatalyst dikecualikan 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

UI yang sesuai:

Tab keluaran/Laporan/Secara otomatis menemukan laporan/'Sertakan/Kecualikan jalur'/Kecualikan jalur
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/'Sertakan/kecualikan jalur'/ Kecualikan 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 laporan analisis statis (SA).

Untuk informasi selengkapnya, lihat Mengkonfigurasi kriteria keberhasilan untuk laporan.

UI yang sesuai:

Tab Keluaran/Laporan/Secara otomatis menemukan laporan/Kriteria sukses
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/Kriteria 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 selengkapnya tentang laporan pengujian, lihatLaporan pengujian.

UI yang sesuai:

Tab Keluaran/Laporan/Secara otomatis menemukan laporan/Kriteria sukses/Tingkat kelulusan
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/Kriteria 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 baris hanya diterapkan pada laporan cakupan kode. Untuk informasi selengkapnya tentang laporan cakupan kode, lihatLaporan cakupan kode.

UI yang sesuai:

Tab Keluaran/Laporan/Secara otomatis menemukan laporan/Kriteria sukses/Cakupan garis
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/Kriteria sukses/Cakupan garis

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:

Tab Keluaran/Laporan/Secara otomatis menemukan laporan/Kriteria sukses/Cakupan cabang
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/Kriteria sukses/Cakupan cabang

Vulnerabilities

(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 SCA laporan agar CodeCatalyst laporan terkait 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 parah, adalah: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Misalnya, jika Anda memilihHIGH, maka HIGH dan CRITICAL kerentanan akan dihitung.
Jumlah maksimum kerentanan dari tingkat keparahan yang ditentukan yang Anda inginkan memungkinkan. Melebihi angka ini menyebabkan CodeCatalyst laporan ditandai sebagai gagal. Nilai yang valid adalah bilangan bulat.

Kriteria kerentanan hanya diterapkan pada SCA laporan. Untuk informasi selengkapnya tentang SCA laporan, lihatLaporan analisis komposisi perangkat lunak.

Untuk menentukan tingkat keparahan minimum, gunakan Severity properti. Untuk menentukan jumlah kerentanan maksimum, gunakan Number properti.

Untuk informasi selengkapnya tentang SCA laporan, lihatJenis laporan kualitas.

UI yang sesuai:

Tab Keluaran/Laporan/Secara otomatis menemukan laporan/Kriteria sukses/Kerentanan
Tab keluaran/Laporan/Konfigurasi laporan secara manual/report-name-1/Kriteria sukses/Kerentanan

Reports

(action-name/Outputs/Reports )

(Opsional)

Bagian yang menentukan konfigurasi untuk laporan pengujian.

UI yang sesuai: Tab keluaran/Laporan

laporan-nama-1

(action-name/Outputs/Reports/laporan-nama-1)

(Diperlukan Reports jika disertakan)

Nama yang ingin Anda berikan ke CodeCatalyst laporan yang akan dihasilkan dari laporan mentah Anda.

UI yang sesuai: Tab keluaran/Laporan/Konfigurasi laporan/Nama laporan secara manual

Format

(action-name/Outputs/Reports/report-name-1/Format)

(Diperlukan Reports jika disertakan)

Tentukan format file yang Anda gunakan untuk laporan Anda. Nilai yang mungkin adalah sebagai berikut.

Untuk laporan pengujian:
- Untuk MentimunJSON, tentukan Mentimun (editor visual) atau CUCUMBERJSON (YAMLeditor).
- Untuk JUnitXML, tentukan JUnit(editor visual) atau JUNITXML (YAMLeditor).
- Untuk NUnitXML, tentukan NUnit(editor visual) atau NUNITXML (YAMLeditor).
- Untuk NUnit 3XML, tentukan NUnit3(editor visual) atau NUNIT3XML (YAMLeditor).
- Untuk Visual StudioTRX, tentukan Visual Studio TRX (editor visual) atau VISUALSTUDIOTRX (YAMLeditor).
- Untuk TestNGXML, tentukan TestNG (editor visual) atau TESTNGXML (editor). YAML
Untuk laporan cakupan kode:
- Untuk CloverXML, tentukan Clover (editor visual) atau CLOVERXML (YAMLeditor).
- Untuk CoberturaXML, tentukan Cobertura (editor visual) atau COBERTURAXML (editor). YAML
- Untuk JaCoCo XML, tentukan JaCoCo(editor visual) atau JACOCOXML (YAMLeditor).
- Untuk SimpleCov JSON dihasilkan oleh simplecov, bukan simplecov-json, tentukan Simplecov (editor visual) atau (editor). SIMPLECOV YAML
Untuk laporan analisis komposisi perangkat lunak (SCA):
- UntukSARIF, tentukan SARIF(editor visual) atau SARIFSCA (YAMLeditor).

UI yang sesuai: Tab keluaran/Laporan/Konfigurasi laporan secara manual/Tambahkan laporan/report-name-1/Jenis laporan dan format Laporan

Configuration

(action-name/Configuration)

(Wajib) Bagian di mana Anda dapat menentukan properti konfigurasi tindakan.

UI yang sesuai: Tab konfigurasi

Steps

(action-name/Configuration/Steps)

(Diperlukan)

Tentukan kode GitHub Tindakan Anda seperti yang muncul di halaman detail tindakan di GitHub Marketplace. Tambahkan kode berikut pedoman ini:

Tempel kode dari steps: bagian GitHub Action ke Steps: bagian CodeCatalyst alur kerja. Kode dimulai dengan tanda hubung (-) dan terlihat mirip dengan yang berikut ini.

GitHub kode untuk ditempelkan:
```
- name: Lint Code Base
  uses: github/super-linter@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: master
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Tinjau kode yang baru saja Anda tempel dan modifikasi seperlunya agar sesuai dengan standar. CodeCatalyst Misalnya, dengan blok kode sebelumnya, Anda dapat menghapus kode di red italics, dan tambahkan kode dalam huruf tebal.

CodeCatalyst alur kerja yaml:
```
Steps:      
   - name: Lint Code Base
     uses: github/super-linter@v4
     env:
       VALIDATE_ALL_CODEBASE: false
       DEFAULT_BRANCH: mastermain
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Untuk kode tambahan yang disertakan dengan GitHub Action tetapi tidak ada di dalam steps: bagian, tambahkan ke CodeCatalyst alur kerja menggunakan kode CodeCatalyst -equivalent. Anda dapat meninjau Definisi alur kerja YAML untuk mendapatkan wawasan tentang bagaimana Anda dapat mem-port GitHub kode Anda CodeCatalyst. Langkah-langkah migrasi terperinci berada di luar cakupan panduan ini.

Berikut adalah contoh cara menentukan jalur file dalam GitHub tindakan Tindakan:


Steps:
  - name: Lint Code Base
    uses: github/super-linter@v4
    ...
  - run: cd /sources/WorkflowSource/MyFolder/  && cat file.txt
  - run: cd /artifacts/MyGitHubAction/MyArtifact/MyFolder/  && cat file2.txt

Untuk informasi selengkapnya tentang menentukan jalur file, lihat Merujuk file repositori sumber danMerujuk file dalam artefak.

UI yang sesuai: Tab konfigurasi/Tindakan GitHub YAML

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Merujuk parameter GitHub keluaran

Mengkonfigurasi gambar komputasi dan runtime