Definizione YAML dell'GitHub azione «Azioni»

Di seguito è riportata la definizione YAML dell'GitHubazione Actions.

Questa definizione di azione esiste come sezione all'interno di un file di definizione del flusso di lavoro più ampio. Per ulteriori informazioni su questo file, consulta Definizione YAML del flusso di lavoro.

Scegliete una proprietà YAML nel codice seguente per vederne una descrizione.

Nota

La maggior parte delle proprietà YAML che seguono hanno elementi dell'interfaccia utente corrispondenti nell'editor visuale. Per cercare un elemento dell'interfaccia utente, usa Ctrl+F. L'elemento verrà elencato con la proprietà YAML associata.


# The workflow definition starts here.
# See Proprietà di primo livello 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

nome dell'azione

(Obbligatorio)

Specificare il nome dell'azione. Tutti i nomi delle azioni devono essere univoci all'interno del flusso di lavoro. I nomi delle azioni sono limitati a caratteri alfanumerici (a-z, A-Z, 0-9), trattini (-) e caratteri di sottolineatura (_). Gli spazi non sono consentiti. Non è possibile utilizzare le virgolette per abilitare caratteri e spazi speciali nei nomi delle azioni.

Interfaccia utente corrispondente: scheda di configurazione/nome azione

Identifier

(nome-azione/) Identifier

Identifica l'azione. Non modificate questa proprietà a meno che non vogliate cambiare la versione. Per ulteriori informazioni, consulta Specificare la versione principale, secondaria o patch di un'azione.

Usa aws/github-actions-runner@v1 per GitHuble azioni Actions.

Interfaccia utente corrispondente: diagramma di workflow, nome azione, etichetta aws/ @v1 github-actions-runner

DependsOn

(nome dell'azione/) DependsOn

(Facoltativo)

Specificate un'azione, un gruppo di azioni o un gate che deve essere eseguito correttamente affinché questa azione venga eseguita.

Per ulteriori informazioni sulla funzionalità «dipende da», vedere. Configurazione delle azioni in modo che dipendano da altre azioni

Interfaccia utente corrispondente: scheda Ingressi/Dipende da - opzionale

Compute

(nome dell'azione/) Compute

(Facoltativo)

Il motore di calcolo utilizzato per eseguire le azioni del flusso di lavoro. È possibile specificare l'elaborazione a livello di flusso di lavoro o a livello di azione, ma non entrambi. Se specificata a livello di flusso di lavoro, la configurazione di calcolo si applica a tutte le azioni definite nel flusso di lavoro. A livello di flusso di lavoro, puoi anche eseguire più azioni sulla stessa istanza. Per ulteriori informazioni, consulta Condivisione dell'elaborazione tra le azioni.

Interfaccia utente corrispondente: nessuna

Fleet

(nome dell'azione /Compute/ Fleet)

(Facoltativo)

Specificate la macchina o il parco macchine che eseguiranno il flusso di lavoro o le azioni del flusso di lavoro. Con le flotte on-demand, all'avvio di un'azione, il flusso di lavoro fornisce le risorse necessarie e le macchine vengono distrutte al termine dell'azione. Esempi di flotte on-demand:,. Linux.x86-64.Large Linux.x86-64.XLarge Per ulteriori informazioni sulle flotte on-demand, vedere. Proprietà del parco veicoli su richiesta

Con le flotte assegnate, puoi configurare una serie di macchine dedicate per eseguire le azioni del flusso di lavoro. Queste macchine rimangono inattive, pronte a elaborare immediatamente le azioni. Per ulteriori informazioni sulle flotte rifornite, vedere. Proprietà del parco veicoli assegnate

Se Fleet viene omesso, l'impostazione predefinita è. Linux.x86-64.Large

Interfaccia utente corrispondente: scheda di configurazione/parco di calcolo - opzionale

Timeout

(nome dell'azione/) Timeout

(Facoltativo)

Specificate il periodo di tempo, in minuti (editor YAML) o ore e minuti (editor visivo), entro il quale l'azione può essere eseguita prima CodeCatalyst che termini l'azione. Il minimo è 5 minuti e il massimo è descritto in. Quote per i flussi di lavoro Il timeout predefinito è lo stesso del timeout massimo.

Interfaccia utente corrispondente: scheda di configurazione/timeout - opzionale

Environment

(nome dell'azione/) Environment

(Facoltativo)

Specificare l' CodeCatalyst ambiente da utilizzare con l'azione. L'azione si connette Account AWS all'Amazon VPC opzionale specificato nell'ambiente scelto. L'azione utilizza il ruolo IAM predefinito specificato nell'ambiente per connettersi a e utilizza il ruolo IAM specificato nella connessione Amazon VPC per connettersi ad Amazon VPC. Account AWS

Nota

Se il ruolo IAM predefinito non dispone delle autorizzazioni richieste dall'azione, puoi configurare l'azione per utilizzare un ruolo diverso. Per ulteriori informazioni, consulta Assegnazione di un ruolo IAM diverso a un'azione.

Per ulteriori informazioni sugli ambienti, consulta Implementazione in ambienti VPC Account AWS e VPC con essi CodeCatalyst eCreazione di un ambiente.

Interfaccia utente corrispondente: scheda di configurazione/ambiente

Name

(nome dell'azione /Environment/ Name)

(Obbligatorio se inclusoEnvironment)

Specificate il nome di un ambiente esistente che desiderate associare all'azione.

Interfaccia utente corrispondente: scheda di configurazione/ambiente

Connections

(nome dell'azione /Environment/ Connections)

(Facoltativo)

Specificare la connessione dell'account da associare all'azione. È possibile specificare al massimo una connessione a un account inEnvironment.

Se non si specifica una connessione all'account:

L'azione utilizza la Account AWS connessione e il ruolo IAM predefinito specificati nell'ambiente della CodeCatalyst console. Per informazioni sull'aggiunta di una connessione all'account e del ruolo IAM predefinito all'ambiente, consultaCreazione di un ambiente.
Il ruolo IAM predefinito deve includere le policy e le autorizzazioni richieste dall'azione. Per determinare quali sono tali politiche e autorizzazioni, consulta la descrizione della proprietà Role nella documentazione sulla definizione YAML dell'azione.

Per ulteriori informazioni sulle connessioni degli account, vedere. Consentire l'accesso alle AWS risorse con connessione Account AWS Per informazioni sull'aggiunta di una connessione tramite account a un ambiente, vedereCreazione di un ambiente.

Interfaccia utente corrispondente: scheda di configurazione/Ambiente/Cosa c'è nel mio ambiente? /menu a tre punti/ Cambia ruolo

Name

(nome dell'azione) /Environment/Connections/ Name

(Obbligatorio se inclusoConnections)

Specificare il nome della connessione all'account.

Interfaccia utente corrispondente: scheda di configurazione/Ambiente/Cosa c'è nel mio ambiente? /menu a tre punti/ Cambia ruolo

Role

(nome dell'azione) /Environment/Connections/ Role

(Obbligatorio se inclusoConnections)

Specificare il nome del ruolo IAM utilizzato da questa azione per accedere e operare in AWS servizi come Amazon S3 e Amazon ECR. Assicurati che questo ruolo venga aggiunto alla tua Account AWS connessione nel tuo spazio. Per aggiungere un ruolo IAM alla connessione di un account, consultaAggiungere ruoli IAM alle connessioni degli account.

Se non specifichi un ruolo IAM, l'azione utilizza il ruolo IAM predefinito elencato nell'ambiente nella CodeCatalyst console. Se utilizzi il ruolo predefinito nell'ambiente, assicurati che abbia le seguenti politiche.

Nota

Puoi usare il CodeCatalystWorkflowDevelopmentRole-spaceName ruolo con questa azione. Per ulteriori informazioni su questo ruolo, consulta Creazione del CodeCatalystWorkflowDevelopmentRole-spaceNameruolo per il tuo account e il tuo spazio. Tieni presente che il CodeCatalystWorkflowDevelopmentRole-spaceName ruolo dispone di autorizzazioni di accesso complete, il che può rappresentare un rischio per la sicurezza. Ti consigliamo di utilizzare questo ruolo solo in tutorial e scenari in cui la sicurezza è meno preoccupante.

avvertimento

Limita le autorizzazioni a quelle richieste dall'azione AzioneGitHub . L'utilizzo di un ruolo con autorizzazioni più ampie potrebbe rappresentare un rischio per la sicurezza.

Interfaccia utente corrispondente: scheda di configurazione/Ambiente/Cosa c'è nel mio ambiente? /menu a tre punti/ Cambia ruolo

Inputs

(nome dell'azione/) Inputs

(Facoltativo)

La Inputs sezione definisce i dati necessari a un'azione durante l'esecuzione di un flusso di lavoro.

Nota

È consentito un massimo di quattro input (una fonte e tre artefatti) per GitHub azione Actions. Le variabili non vengono conteggiate per questo totale.

Se è necessario fare riferimento a file che risiedono in input diversi (ad esempio una sorgente e un artefatto), l'input di origine è l'input principale e l'artefatto è l'input secondario. I riferimenti ai file negli input secondari richiedono un prefisso speciale per distinguerli dal primario. Per informazioni dettagliate, vedi Esempio: riferimento a file in più artefatti.

Interfaccia utente corrispondente: scheda Ingressi

Sources

(nome dell'azione /Inputs/ Sources)

(Facoltativo)

Specificate le etichette che rappresentano i repository di origine che saranno necessari all'azione. Attualmente, l'unica etichetta supportata èWorkflowSource, che rappresenta l'archivio di origine in cui è archiviato il file di definizione del flusso di lavoro.

Se si omette una fonte, è necessario specificare almeno un elemento di input in. action-name/Inputs/Artifacts

Per ulteriori informazioni sulle origini, consulta Connessione di un flusso di lavoro a un archivio di origine.

Interfaccia utente corrispondente: scheda Ingressi/Sorgenti - opzionale

Artifacts - input

(nome dell'azione) /Inputs/ Artifacts

(Facoltativo)

Specificate gli artefatti delle azioni precedenti che desiderate fornire come input per questa azione. Questi artefatti devono essere già definiti come artefatti di output nelle azioni precedenti.

Se non si specifica alcun artefatto di input, è necessario specificare almeno un repository di origine in. action-name/Inputs/Sources

Per ulteriori informazioni sugli artefatti, inclusi esempi, vedere. Condivisione di dati tra azioni in un flusso di lavoro utilizzando artefatti

Nota

Se l'elenco a discesa Artifacts - opzionale non è disponibile (editor visivo) o se si verificano errori durante la convalida di YAML (editor YAML), è possibile che l'azione supporti un solo input. In questo caso, prova a rimuovere l'input sorgente.

Interfaccia utente corrispondente: scheda Ingressi/Artefatti - opzionale

Variables - input

(nome dell'azione) /Inputs/ Variables

(Facoltativo)

Specificate una sequenza di coppie nome/valore che definiscono le variabili di input che desiderate rendere disponibili all'azione. I nomi delle variabili sono limitati a caratteri alfanumerici (a-z, A-Z, 0-9), trattini (-) e caratteri di sottolineatura (_). Gli spazi non sono consentiti. Non è possibile utilizzare le virgolette per abilitare caratteri e spazi speciali nei nomi delle variabili.

Per ulteriori informazioni sulle variabili, inclusi esempi, vedereConfigurazione e utilizzo delle variabili in un flusso di lavoro.

Interfaccia utente corrispondente: scheda Input/Variabili - opzionale

Outputs

(nome dell'azione/) Outputs

(Facoltativo)

Definisce i dati emessi dall'azione durante l'esecuzione di un flusso di lavoro.

Interfaccia utente corrispondente: scheda Output

Artifacts - output

(nome dell'azione /Outputs/ Artifacts)

(Facoltativo)

Specificate il nome di un artefatto generato dall'azione. I nomi degli Artifact devono essere univoci all'interno di un flusso di lavoro e sono limitati ai caratteri alfanumerici (a-z, A-Z, 0-9) e ai caratteri di sottolineatura (_). Spazi, trattini (-) e altri caratteri speciali non sono consentiti. Non è possibile utilizzare le virgolette per abilitare spazi, trattini e altri caratteri speciali nei nomi degli artefatti di output.

Per ulteriori informazioni sugli artefatti, inclusi esempi, vedere. Condivisione di dati tra azioni in un flusso di lavoro utilizzando artefatti

Interfaccia utente corrispondente: scheda Outputs/Artifacts

Name

(nome dell'azione) /Outputs/Artifacts/ Name

(Obbligatorio se inclusoArtifacts - output)

Per ulteriori informazioni sugli artefatti, inclusi esempi, vedere. Condivisione di dati tra azioni in un flusso di lavoro utilizzando artefatti

Interfaccia utente corrispondente: scheda Outputs/Artifacts/Aggiungi artefatto/Crea nome artefatto

Files

(nome dell'azione) /Outputs/Artifacts/ Files

(Obbligatorio se inclusoArtifacts - output)

Specificate i file CodeCatalyst inclusi nell'artefatto generato dall'azione. Questi file vengono generati dall'azione del flusso di lavoro durante l'esecuzione e sono disponibili anche nell'archivio di origine. I percorsi dei file possono risiedere in un repository di origine o in un elemento di un'azione precedente e sono relativi al repository di origine o alla radice dell'elemento. È possibile utilizzare modelli a globo per specificare i percorsi. Esempi:

Per specificare un singolo file che si trova nella radice della posizione di creazione o della posizione del repository di origine, usa. my-file.jar
Per specificare un singolo file in una sottodirectory, usa directory/my-file.jar o. directory/subdirectory/my-file.jar
Per specificare tutti i file, utilizzare"**/*". Il pattern a ** glob indica che deve corrispondere a un numero qualsiasi di sottodirectory.
Per specificare tutti i file e le directory in una directory denominata, usa. directory "directory/**/*" Il pattern a ** glob indica che deve corrispondere a un numero qualsiasi di sottodirectory.
Per specificare tutti i file in una directory denominatadirectory, ma non nessuna delle sue sottodirectory, usa. "directory/*"

Nota

Se il percorso del file include uno o più asterischi (*) o un altro carattere speciale, racchiudi il percorso tra virgolette doppie (). "" Per ulteriori informazioni sui caratteri speciali, vedere. Linee guida e convenzioni sulla sintassi

Per ulteriori informazioni sugli artefatti, inclusi esempi, vedere. Condivisione di dati tra azioni in un flusso di lavoro utilizzando artefatti

Nota

Potrebbe essere necessario aggiungere un prefisso al percorso del file per indicare in quale elemento o fonte trovarlo. Per ulteriori informazioni, consulta Riferimento ai file in un archivio di origine e Riferimento ai file in un artefatto.

Interfaccia utente corrispondente: scheda Output/Artifacts/Aggiungi artefatto/File prodotti da build

Variables - output

(nome dell'azione) /Outputs/ Variables

(Facoltativo)

Specificate le variabili che desiderate che l'azione esporti in modo che siano disponibili per l'uso da parte delle azioni successive.

Per ulteriori informazioni sulle variabili, inclusi esempi, vedereConfigurazione e utilizzo delle variabili in un flusso di lavoro.

Interfaccia utente corrispondente: scheda Output/Variabili/ Aggiungi variabile

nome-variabile-1

(nome-azione nome-variabile-1) /Outputs/Variables

(Facoltativo)

Specificate il nome di una variabile che desiderate che l'azione esporti. Questa variabile deve essere già definita nella Steps sezione Inputs o della stessa azione.

Per ulteriori informazioni sulle variabili, inclusi esempi, vedereConfigurazione e utilizzo delle variabili in un flusso di lavoro.

Interfaccia utente corrispondente: scheda Output/Variabili/Aggiungi variabile/Nome

AutoDiscoverReports

(nome dell'azione) /Outputs/ AutoDiscoverReports

(Facoltativo)

Definisce la configurazione per la funzione di individuazione automatica.

Quando abiliti l'individuazione automatica, tutte le CodeCatalyst ricerche Inputs passano all'azione e tutti i file generati dall'azione stessa, alla ricerca di report di test, copertura del codice e analisi della composizione del software (SCA). Per ogni report trovato, lo CodeCatalyst trasforma in un report. CodeCatalyst Un CodeCatalyst report è un report completamente integrato nel CodeCatalyst servizio e che può essere visualizzato e manipolato tramite la CodeCatalyst console.

Nota

Per impostazione predefinita, la funzione di individuazione automatica ispeziona tutti i file. È possibile limitare i file da ispezionare utilizzando le IncludePaths proprietà o. ExcludePaths

Interfaccia utente corrispondente: nessuna

Enabled

(nome dell'azione /Outputs/AutoDiscoverReports/ Enabled)

(Facoltativo)

Abilita o disabilita la funzione di rilevamento automatico.

I valori validi sono true e false.

Se Enabled viene omesso, l'impostazione predefinita è. true

Interfaccia utente corrispondente: scheda Outputs/Reports/ Rileva automaticamente i report

ReportNamePrefix

(nome dell'azione) /Outputs/AutoDiscoverReports/ ReportNamePrefix

(Obbligatorio se AutoDiscoverReports è incluso e abilitato)

Specificate un prefisso che CodeCatalyst precede tutti i report trovati per assegnare un nome ai report associati. CodeCatalyst Ad esempio, se si specifica un prefisso di AutoDiscovered e CodeCatalyst rileva automaticamente due rapporti di test TestSuiteOne.xml eTestSuiteTwo.xml, i CodeCatalyst report associati verranno denominati e. AutoDiscoveredTestSuiteOne AutoDiscoveredTestSuiteTwo

Interfaccia utente corrispondente: scheda Output/Reports/Individua automaticamente i report/Prefisso Report

IncludePaths

(nome dell'azione) /Outputs/AutoDiscoverReports/ IncludePaths

(nome-azione nome-rapporto-1//Outputs/Reports/) IncludePaths

(Richiesto se AutoDiscoverReports è incluso e abilitato o se è incluso) Reports

Specificate i file e i percorsi dei file da CodeCatalyst includere nella ricerca di report non elaborati. Ad esempio, se si specifica"/test/report/*", CodeCatalyst cerca la directory nell'intera immagine di build utilizzata dall'azione per cercare la /test/report/* directory. Quando trova quella directory, cerca CodeCatalyst i report in quella directory.

Nota

Se il percorso del file include uno o più asterischi (*) o altri caratteri speciali, racchiudi il percorso tra virgolette doppie (). "" Per ulteriori informazioni sui caratteri speciali, vedere. Linee guida e convenzioni sulla sintassi

Se questa proprietà viene omessa, l'impostazione predefinita è"**/*", ovvero la ricerca include tutti i file in tutti i percorsi.

Nota

Per i report configurati manualmente, IncludePaths deve essere presente uno schema a globo che corrisponda a un singolo file.

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Scopri automaticamente i report/'Includi/escludi percorsi'/Includi percorsi
Scheda Output/Rapporti/Configurazione manuale dei report/ nome-report-1 /'Includi/escludi percorsi'/ Includi percorsi

ExcludePaths

(nome /Outputs/AutoDiscoverReports/ ExcludePathsdell'azione)

(nome-azione nome-rapporto-1//Outputs/Reports/) ExcludePaths

(Facoltativo)

Specificate i file e i percorsi dei file da CodeCatalyst escludere dalla ricerca di report non elaborati. Ad esempio, se si specifica"/test/my-reports/**/*", non CodeCatalyst cercherà i file nella /test/my-reports/ directory. Per ignorare tutti i file in una directory, utilizzate il pattern **/* glob.

Nota

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Scopri automaticamente i report/'Includi/escludi percorsi'/Escludi percorsi
Scheda Output/Rapporti/Configurazione manuale dei report/ nome-report-1 /'Includi/escludi percorsi'/ Escludi percorsi

SuccessCriteria

(nome /Outputs/AutoDiscoverReports/ SuccessCriteriadell'azione)

(nome-azione nome-rapporto-1//Outputs/Reports/) SuccessCriteria

(Facoltativo)

Specificate i criteri di successo per i report di test, copertura del codice, analisi della composizione del software (SCA) e analisi statica (SA).

Per ulteriori informazioni, consulta Configurazione dei criteri di successo per i report.

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Individuazione automatica dei report/Criteri di successo
Scheda Output/Rapporti/Configurazione manuale/report-name-1//Criteri di successo

PassRate

(nome /Outputs/AutoDiscoverReports/SuccessCriteria/ PassRatedell'azione)

(nome-azione /Outputs/Reports/ nome-report-1) /SuccessCriteria/ PassRate

(Facoltativo)

Specificate la percentuale di test da superare in un rapporto di prova affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono i numeri decimali. Ad esempio, 50, 60.5. I criteri relativi alla percentuale di superamento vengono applicati solo ai rapporti di prova. Per ulteriori informazioni sui rapporti di prova, vedereRapporti dei test.

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Rilevamento automatico dei report/Criteri di successo/Percentuale di successo
Scheda Output/Rapporti/Configurazione manuale dei report/nome-report-1 /Criteri di successo/ Percentuale di successo

LineCoverage

(nome /Outputs/AutoDiscoverReports/SuccessCriteria/ LineCoveragedell'azione)

(nome-azione /Outputs/Reports/ nome-report-1) /SuccessCriteria/ LineCoverage

(Facoltativo)

Specificate la percentuale di righe da coprire in un rapporto sulla copertura del codice affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono i numeri decimali. Ad esempio, 50, 60.5. I criteri di copertura delle linee vengono applicati solo ai report sulla copertura del codice. Per ulteriori informazioni sui rapporti sulla copertura del codice, vedereRapporti sulla copertura del codice.

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Rileva automaticamente i report/Criteri di successo/Copertura di linea
Scheda Output/Rapporti/Configurazione manuale dei report/nome-report-1 /Criteri di successo/ Copertura di linea

BranchCoverage

(nome /Outputs/AutoDiscoverReports/SuccessCriteria/ BranchCoveragedell'azione)

(nome-azione /Outputs/Reports/ nome-report-1) /SuccessCriteria/ BranchCoverage

(Facoltativo)

Specificate la percentuale di filiali in un rapporto sulla copertura del codice che deve essere coperta affinché il CodeCatalyst rapporto associato venga contrassegnato come approvato. I valori validi includono i numeri decimali. Ad esempio, 50, 60.5. I criteri di copertura delle filiali vengono applicati solo ai report sulla copertura del codice. Per ulteriori informazioni sui rapporti sulla copertura del codice, vedereRapporti sulla copertura del codice.

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Rilevamento automatico dei report/Criteri di successo/Copertura della filiale
Scheda Output/Rapporti/Configurazione manuale dei report/nome-report-1 /Criteri di successo/ Copertura della filiale

Vulnerabilities

(nome /Outputs/AutoDiscoverReports/SuccessCriteria/ Vulnerabilitiesdell'azione)

(nome-azione /Outputs/Reports/ nome-report-1) /SuccessCriteria/ Vulnerabilities

(Facoltativo)

Specificate il numero e la gravità massimi di vulnerabilità consentiti nel rapporto SCA affinché il rapporto associato venga contrassegnato come superato. CodeCatalyst Per specificare le vulnerabilità, è necessario specificare:

La gravità minima delle vulnerabilità da includere nel conteggio. I valori validi, dal più grave al meno grave, sono:CRITICAL,HIGH,, MEDIUMLOW,INFORMATIONAL.

Ad esempio, se si sceglieHIGH, verranno HIGH CRITICAL conteggiate tutte le vulnerabilità.
Il numero massimo di vulnerabilità della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che il CodeCatalyst rapporto venga contrassegnato come fallito. I valori validi sono numeri interi.

I criteri di vulnerabilità vengono applicati solo ai report SCA. Per ulteriori informazioni sui report SCA, vedere. Rapporti di analisi della composizione del software

Per specificare la severità minima, utilizzare la Severity proprietà. Per specificare il numero massimo di vulnerabilità, utilizzare la Number proprietà.

Per ulteriori informazioni sui report SCA, vedere. Tipi di report sulla qualità

Interfaccia utente corrispondente:

Scheda Output/Rapporti/Rileva automaticamente i report/Criteri di successo/Vulnerabilità
Scheda Output/Rapporti/Configurazione manuale/report-name-1 /Criteri di successo/ Vulnerabilità

Reports

(nome /Outputs/ Reportsdell'azione)

(Facoltativo)

Una sezione che specifica la configurazione per i report di test.

Interfaccia utente corrispondente: scheda Output/Report

nome-rapporto-1

(nome-azione nome-report-1) /Outputs/Reports/

(Obbligatorio se incluso) Reports

Il nome che vuoi dare al CodeCatalyst rapporto che verrà generato dai tuoi report non elaborati.

Interfaccia utente corrispondente: scheda Output/Rapporti/Configurazione manuale dei report/Nome del rapporto

Format

(/Outputs/Reports/nome azione Formatnome-rapporto 1/)

(Obbligatorio se incluso) Reports

Specificate il formato di file che state utilizzando per i report. I valori possibili sono i seguenti.

Per i rapporti sui test:
- Per Cucumber JSON, specifica Cucumber (editor visivo) o CUCUMBERJSON (editor YAML).
- Per JUnit XML, specifica JUnit (editor visivo) o (editor YAML). JUNITXML
- Per NUnit XML, specifica nUnit (editor visivo) o (editor YAML). NUNITXML
- Per NUnit 3 XML, specifica nUnit3 (editor visivo) o (editor YAML). NUNIT3XML
- Per Visual Studio TRX, specifica Visual Studio TRX (editor visivo) o (editor YAML). VISUALSTUDIOTRX
- Per TestNg XML, specificare TestNg (editor visivo) o TESTNGXML (editor YAML).
Per i report sulla copertura del codice:
- Per Clover XML, specifica Clover (editor visivo) o CLOVERXML (editor YAML).
- Per Cobertura XML, specifica Cobertura (editor visivo) o (editor YAML). COBERTURAXML
- Per JaCoCo XML, specifica JaCoCo(editor visivo) o (editor YAML). JACOCOXML
- Per SimpleCov JSON generato da simplecov, non da simplecov-json , specifica Simplecov (editor visivo) o (editor YAML). SIMPLECOV
Per i report di analisi della composizione del software (SCA):
- Per SARIF, specifica SARIF (editor visivo) o SARIFSCA (editor YAML).

Interfaccia utente corrispondente: scheda Output/Rapporti/Configurazione manuale dei report/Aggiungi report/nome-report-1/ Tipo di report e formato del report

Configuration

(nome-azione/) Configuration

(Obbligatorio) Una sezione in cui è possibile definire le proprietà di configurazione dell'azione.

Interfaccia utente corrispondente: scheda Configurazione

Steps

(nome dell'azione /Configuration/ Steps)

(Obbligatorio)

Specificate il codice GitHub dell'azione così come appare nella pagina dei dettagli dell'azione in GitHub Marketplace. Aggiungi il codice seguendo queste linee guida:

Incolla il codice dalla steps: sezione GitHub Azione nella Steps: sezione del CodeCatalyst flusso di lavoro. Il codice inizia con un trattino (-) e ha un aspetto simile al seguente.

GitHub codice da incollare:
```
- name: Lint Code Base
  uses: github/super-linter@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: master
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Rivedi il codice appena incollato e modificalo se necessario in modo che sia conforme agli CodeCatalyst standard. Ad esempio, con il blocco di codice precedente, è possibile rimuovere il codice in corsivo rosso e aggiungere il codice in grassetto.

CodeCatalyst workflow yaml:
```
Steps:      
   - name: Lint Code Base
     uses: github/super-linter@v4
     env:
       VALIDATE_ALL_CODEBASE: false
       DEFAULT_BRANCH: mastermain
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Per il codice aggiuntivo incluso nell' GitHub Action ma che non esiste all'interno della steps: sezione, aggiungilo al CodeCatalyst flusso di lavoro utilizzando il codice CodeCatalyst -equivalent. Puoi consultarla Definizione YAML del flusso di lavoro per avere informazioni dettagliate su come potresti trasferire il tuo GitHub codice. CodeCatalyst Le fasi dettagliate della migrazione non rientrano nell'ambito di questa guida.

Ecco un esempio di come specificare i percorsi dei file in un'azione GitHub Actions:


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

Per ulteriori informazioni sulla specificazione dei percorsi dei file, vedere Riferimento ai file in un archivio di origine eRiferimento ai file in un artefatto.

Interfaccia utente corrispondente: scheda di configurazione/ GitHub Azioni YAML

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Riferimento a un parametro di GitHub output

Configurazione delle immagini Docker dell'ambiente di calcolo e runtime