Amazon non CodeCatalyst è più aperto a nuovi clienti. I clienti esistenti possono continuare a utilizzare il servizio normalmente. Per ulteriori informazioni, consulta Come migrare da CodeCatalyst.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Costruisci e testa azioni YAML
Quella che segue è la definizione YAML delle azioni di compilazione e test. C'è un riferimento per due azioni perché le loro proprietà YAML sono molto simili.
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 visualizzarne 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, usate Ctrl+F. L'elemento verrà elencato con la proprietà YAML associata.
# The workflow definition starts here.
# See Top-level proprietà 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
nome-azione
(Obbligatorio)
Specifica 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 trattini bassi (_). Gli spazi non sono consentiti. Non è possibile utilizzare le virgolette per abilitare caratteri speciali e spazi nei nomi delle azioni.
Interfaccia utente corrispondente: scheda di configurazione/nome dell'azione
Identificatore
(action-name/Identifier)
Identifica l'azione. Non modificate questa proprietà a meno che non vogliate cambiare la versione. Per ulteriori informazioni, consulta Specificare la versione dell'azione da utilizzare.
Usalo aws/build@v1 per creare azioni.
Da utilizzare aws/managed-test@v1 per azioni di test.
Interfaccia utente corrispondente: Workflow diagram/Action -name/ label aws/build@v1|aws/managed-test@v1
DependsOn
(action-name/DependsOn)
(Facoltativo)
Specifica un'azione, un gruppo di azioni o un gate che deve essere eseguito correttamente per poter eseguire questa azione.
Per ulteriori informazioni sulla funzionalità «dipende da», vedere. Azioni di sequenziamento
Interfaccia utente corrispondente: scheda Ingressi/ Dipende da - opzionale
Calcolo
(action-name/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
Tipo
(action-name/Compute/Tipo)
(Obbligatorio se Calcolo è incluso)
Il tipo di motore di elaborazione. È possibile utilizzare uno dei seguenti valori:
-
EC2 (editor visuale) o
EC2(editor YAML)Ottimizzato per la flessibilità durante l'esecuzione delle azioni.
-
Lambda (editor visuale) o
Lambda(editor YAML)Velocità di avvio delle azioni ottimizzate.
Per ulteriori informazioni sui tipi di calcolo, consulta Tipi di calcolo.
Interfaccia utente corrispondente: scheda di configurazione/tipo di elaborazione
Parco istanze
(action-name/Compute/Fleet)
(Facoltativo)
Specifica la macchina o il parco macchine su cui verranno eseguiti il flusso di lavoro o le azioni del flusso di lavoro. Con le flotte on-demand, quando un'azione viene avviata, il flusso di lavoro fornisce le risorse necessarie e le macchine vengono distrutte al termine dell'azione. Esempi di flotte su richiesta:,. Linux.x86-64.Large Linux.x86-64.XLarge Per ulteriori informazioni sulle flotte su richiesta, vedere. On-demand proprietà della flotta
Con le flotte con provisioning, configuri un set di macchine dedicate per eseguire le azioni del flusso di lavoro. Queste macchine rimangono inattive, pronte a elaborare le azioni immediatamente. Per ulteriori informazioni sulle flotte predisposte, vedere. Proprietà del parco istanze con provisioning
Se Fleet viene omesso, l'impostazione predefinita è. Linux.x86-64.Large
Interfaccia utente corrispondente: scheda Configurazione/ Compute fleet
Timeout
(action-name/Timeout)
(Facoltativo)
Specifica il periodo di tempo, in minuti (editor YAML) o ore e minuti (editor visuale), che l'azione può eseguire prima CodeCatalyst che termini l'azione. Il minimo è 5 minuti e il massimo è descritto in. Quote per i flussi di lavoro in CodeCatalyst Il timeout predefinito è uguale al timeout massimo.
Interfaccia utente corrispondente: scheda di configurazione/ Timeout - opzionale
Ambiente
(action-name/Environment)
(Facoltativo)
Specifica 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 Account AWS ruolo IAM specificato nella connessione Amazon VPC per connettersi ad Amazon VPC.
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 Modificare il ruolo IAM di un'azione.
Per ulteriori informazioni sugli ambienti, consulta Implementazione in Account AWS e VPC eCreazione di un ambiente.
Interfaccia utente corrispondente: scheda Configurazione/Ambiente
Nome
(action-name/Environment/Name)
(Facoltativo)
Specificate il nome di un ambiente esistente da associare all'azione.
Interfaccia utente corrispondente: scheda Configurazione/Ambiente
Connessioni
(action-name/Environment/Connections)
(Facoltativo)
Specifica la connessione all'account da associare all'azione. È possibile specificare un massimo di una connessione all'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 nella 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 politiche e le autorizzazioni richieste dall'azione. Per determinare quali sono tali politiche e autorizzazioni, consulta la descrizione della proprietà Role nella documentazione delle definizioni YAML dell'azione.
Per ulteriori informazioni sulle connessioni degli account, vedere. Consentire l'accesso a AWS risorse connesse Account AWS Per informazioni sull'aggiunta di una connessione di account a un ambiente, vedereCreazione di un ambiente.
Interfaccia utente corrispondente: tab/Environment Configurazione/Cosa c'è? my-environment /menu a tre punti/ Cambia ruolo
Nome
(action-name/Environment/Connections/Name)
(Obbligatorio se è inclusoConnessioni)
Specifica il nome della connessione all'account.
Interfaccia utente corrispondente: tab/Environment Configurazione/Cosa c'è? my-environment /menu a tre punti/ Cambia ruolo
Ruolo
(action-name/Environment/Connections/Role)
(Obbligatorio se è inclusoConnessioni)
Specifica 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 sia aggiunto alla tua Account AWS connessione nel tuo spazio. Per aggiungere un ruolo IAM a una connessione di account, consultaAggiunta di ruoli IAM alle connessioni degli account.
Se non si specifica 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 utilizzare il CodeCatalystWorkflowDevelopmentRole- 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 spaceNameCodeCatalystWorkflowDevelopmentRole- ruolo dispone di autorizzazioni di accesso complete che possono rappresentare un rischio per la sicurezza. Ti consigliamo di utilizzare questo ruolo solo in tutorial e scenari in cui la sicurezza è meno importante. spaceName
avvertimento
Limita le autorizzazioni a quelle richieste dalle azioni di compilazione e test. L'utilizzo di un ruolo con autorizzazioni più ampie potrebbe rappresentare un rischio per la sicurezza.
Interfaccia utente corrispondente: tab/Environment Configurazione/Cosa c'è? my-environment /menu a tre punti/ Cambia ruolo
Caching
(action-name/Caching)
(Facoltativo)
Una sezione in cui è possibile specificare una cache per salvare i file su disco e ripristinarli da tale cache nelle successive esecuzioni del flusso di lavoro.
Per ulteriori informazioni sulla memorizzazione nella cache dei file, vedere. Memorizzazione nella cache dei file tra le esecuzioni del workflow
Interfaccia utente corrispondente: scheda di configurazione/memorizzazione nella cache dei file - opzionale
FileCaching
(action-name/Caching/FileCaching)
(Facoltativo)
Una sezione che specifica la configurazione per una sequenza di cache.
Interfaccia utente corrispondente: memorizzazione nella tab/File cache di configurazione - opzionale/ Aggiungi cache
nome-chiave-1
(action-name/Caching/FileCaching/key-name-1)
(Facoltativo)
Specifica il nome della proprietà della cache principale. I nomi delle proprietà della cache devono essere univoci all'interno del flusso di lavoro. Ogni azione può contenere fino a cinque vociFileCaching.
Interfaccia utente corrispondente: tab/File caching di configurazione - optional/Add cache/ Key
Path
(action-name/Caching/FileCaching/key-name-1/Path)
(Facoltativo)
Specifica il percorso associato per la tua cache.
Interfaccia utente corrispondente: memorizzazione nella tab/File cache della configurazione - optional/Add cache/ Path
RestoreKeys
(action-name/Caching/FileCaching/key-name-1/RestoreKeys)
(Facoltativo)
Specifica la chiave di ripristino da utilizzare come riserva quando non è possibile trovare la proprietà della cache primaria. I nomi delle chiavi di ripristino devono essere univoci all'interno del flusso di lavoro. Ogni cache può contenere fino a cinque vociRestoreKeys.
Interfaccia utente corrispondente: tab/File cache di configurazione - chiavi optional/Add cache/ ripristino - opzionale
Input
(action-name/Inputs)
(Facoltativo)
La Inputs sezione definisce i dati necessari a un'azione durante l'esecuzione di un flusso di lavoro.
Nota
Sono consentiti un massimo di quattro input (una fonte e tre artefatti) per azione di compilazione o azione di test. Le variabili non vengono conteggiate ai fini di questo totale.
Se è necessario fare riferimento a file che risiedono in ingressi diversi (ad esempio una sorgente e un artefatto), l'ingresso sorgente è l'ingresso principale e l'artefatto è l'ingresso secondario. I riferimenti ai file negli input secondari richiedono un prefisso speciale per distinguerli da quelli primari. Per informazioni dettagliate, vedi Esempio: riferimento a file in più artefatti.
Interfaccia utente corrispondente: scheda Ingressi
Origini
(action-name/Inputs/Sources)
(Facoltativo)
Specifica le etichette che rappresentano i repository di origine che saranno necessari per l'azione. Attualmente, l'unica etichetta supportata èWorkflowSource, che rappresenta il repository 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 dei repository di origine ai flussi di lavoro.
Interfaccia utente corrispondente: nessuna
Artefatti: input
(action-name/Inputs/Artifacts)
(Facoltativo)
Specifica gli artefatti delle azioni precedenti che desideri fornire come input per questa azione. Questi artefatti devono essere già definiti come artefatti di output nelle azioni precedenti.
Se non specificate alcun artefatto di input, dovete specificare almeno un repository di origine in. action-name/Inputs/Sources
Per ulteriori informazioni sugli artefatti, inclusi gli esempi, vedere. Condivisione di artefatti e file tra azioni
Nota
Se l'elenco a discesa Artifacts - opzionale non è disponibile (editor visuale) 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/Artifacts - opzionale
Variabili: input
(action-name/Inputs/Variables)
(Facoltativo)
Specificate una sequenza di name/value coppie 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 trattini bassi (_). Gli spazi non sono consentiti. Non è possibile utilizzare le virgolette per abilitare caratteri speciali e spazi nei nomi delle variabili.
Per ulteriori informazioni sulle variabili, inclusi gli esempi, vedereUtilizzo delle variabili nei flussi di lavoro.
Interfaccia utente corrispondente: scheda Ingressi/Variabili - opzionale
Output
(action-name/Outputs)
(Facoltativo)
Definisce i dati generati dall'azione durante l'esecuzione di un flusso di lavoro.
Interfaccia utente corrispondente: scheda Output
Artefatti - output
(action-name/Outputs/Artifacts)
(Facoltativo)
Specifica il nome di un artefatto generato dall'azione. I nomi degli artefatti devono essere univoci all'interno di un flusso di lavoro e sono limitati a caratteri alfanumerici (a-z, A-Z, 0-9) e 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 gli esempi, vedere. Condivisione di artefatti e file tra azioni
Interfaccia utente corrispondente: scheda Outputs/ Artifacts
Nome
(action-name/Outputs/Artifacts/Name)
(Obbligatorio se è incluso) Artefatti - output
Specifica il nome di un artefatto generato dall'azione. I nomi degli artefatti devono essere univoci all'interno di un flusso di lavoro e sono limitati a caratteri alfanumerici (a-z, A-Z, 0-9) e 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 gli esempi, vedere. Condivisione di artefatti e file tra azioni
Interfaccia utente corrispondente: Outputs tab/Artifacts /New output/ Build (nome dell'artefatto)
File
(action-name/Outputs/Artifacts/Files)
(Obbligatorio se è incluso) Artefatti - output
Specifica i file CodeCatalyst inclusi nell'artefatto generato dall'azione. Questi file vengono generati dall'azione del flusso di lavoro quando viene eseguita e sono disponibili anche nel repository 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'artifact. È possibile utilizzare i pattern glob per specificare i percorsi. Esempi:
-
Per specificare un singolo file che si trova nella radice della posizione di compilazione o della posizione del repository di origine, usa.
my-file.jar -
Per specificare un singolo file in una sottodirectory, usa
directory/my-file.jaro.directory/subdirectory/my-file.jar -
Per specificare tutti i file, utilizzare
"**/*". Il pattern**glob indica di corrispondere a un numero qualsiasi di sottodirectory. -
Per specificare tutti i file e le directory in una directory denominata, usa.
directory"directory/**/*"Il modello**glob indica di corrispondere a un numero qualsiasi di sottodirectory. -
Per specificare tutti i file in una directory denominata
directory, 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 gli esempi, vedere. Condivisione di artefatti e file tra azioni
Nota
Potrebbe essere necessario aggiungere un prefisso al percorso del file per indicare in quale artefatto o fonte trovarlo. Per ulteriori informazioni, consulta Riferimento ai file del repository di origine e Riferimento ai file in un artefatto.
Interfaccia utente corrispondente: Outputs tab/Artifacts /New output/ Files prodotti da build
Variabili - output
(action-name/Outputs/Variables)
(Facoltativo)
Specificate le variabili che desiderate esportare dall'azione in modo che siano disponibili per l'uso nelle azioni successive.
Per ulteriori informazioni sulle variabili, inclusi gli esempi, vedereUtilizzo delle variabili nei flussi di lavoro.
Interfaccia utente corrispondente: tab/Variables Outputs/Aggiungi variabile
nome-variabile-1
(action-name/Outputs/Variables/variable-name-1)
(Facoltativo)
Specifica il nome di una variabile che desideri esportare con l'azione. Questa variabile deve essere già definita nella Steps sezione Inputs o della stessa azione.
Per ulteriori informazioni sulle variabili, inclusi gli esempi, vedereUtilizzo delle variabili nei flussi di lavoro.
Interfaccia utente corrispondente: tab/Variables Outputs/Aggiungi variabile/ Nome
AutoDiscoverReports
(action-name/Outputs/AutoDiscoverReports)
(Facoltativo)
Definisce la configurazione per la funzionalità di rilevamento automatico.
Quando abiliti il rilevamento automatico, CodeCatalyst esegue la ricerca in tutti i file Inputs passati all'azione e in tutti i file generati dall'azione stessa, cercando i 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 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: Output/report tab/Reports Auto-discover
Abilitato
(action-name/Outputs/AutoDiscoverReports/Enabled)
(Facoltativo)
Abilita o disabilita la funzione di rilevamento automatico.
I valori validi sono true e false.
Se Enabled viene omessa, l'impostazione predefinita è. true
Interfaccia utente corrispondente: Output/report tab/Reports Auto-discover
ReportNamePrefix
(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)
(Obbligatorio se AutoDiscoverReports è incluso e abilitato)
Specifica un prefisso che CodeCatalyst anteponga a tutti i report trovati per assegnare un nome ai report associati. CodeCatalyst Ad esempio, se si specifica il prefisso e vengono CodeCatalyst rilevati automaticamente due report di AutoDiscovered test TestSuiteOne.xml eTestSuiteTwo.xml, i report associati CodeCatalyst verranno denominati e. AutoDiscoveredTestSuiteOne AutoDiscoveredTestSuiteTwo
Interfaccia utente corrispondente: tab/Reports Outputs/Nome del prefisso
IncludePaths
(action-name/Outputs/AutoDiscoverReports/IncludePaths)
Or
(action-name/Outputs/Reports/report-name-1/IncludePaths)
(Obbligatorio se AutoDiscoverReports è incluso e abilitato o se Report è incluso)
Specifica i file e i percorsi dei file CodeCatalyst inclusi nella ricerca dei report non elaborati. Ad esempio, se specifichi"/test/report/*", CodeCatalyst cerca l'intera immagine di build utilizzata dall'azione cercando la /test/report/* directory. Quando trova quella directory CodeCatalyst , cerca 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 è"**/*": la ricerca include tutti i file in tutti i percorsi.
Nota
Per i report configurati manualmente, IncludePaths deve essere un modello globale che corrisponda a un singolo file.
Interfaccia utente corrispondente:
-
Uscite tab/Reports/esclude percorsi Auto-discover reports/Include/Include percorsi
-
Uscite /Configurazione tab/Reports manuale dei rapporti//percorsi/ Includi percorsi
report-name-1Include/exclude
ExcludePaths
(action-name/Outputs/AutoDiscoverReports/ExcludePaths)
Or
(action-name/Outputs/Reports/report-name-1/ExcludePaths)
(Facoltativo)
Specifica i file e i percorsi dei file da CodeCatalyst escludere durante la ricerca di report non elaborati. Ad esempio, se lo specifichi"/test/my-reports/**/*", non CodeCatalyst cercherà i file nella /test/my-reports/ directory. Per ignorare tutti i file in una directory, usa il pattern **/* glob.
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, vedereLinee guida e convenzioni sulla sintassi.
Interfaccia utente corrispondente:
-
Uscite tab/Reports//esclude percorsi Auto-discover reports/Include/Esclude percorsi
-
Uscite /Configurazione tab/Reports manuale dei rapporti//percorsi/ Escludi percorsi
report-name-1Include/exclude
SuccessCriteria
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria)
(Facoltativo)
Specifica i criteri di successo per i report di test, copertura del codice, analisi della composizione software (SCA) e analisi statica (SA).
Per ulteriori informazioni, consulta Configurazione dei criteri di successo per i report.
Interfaccia utente corrispondente: criteri di tab/Reports uscita/successo
PassRate
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/PassRate)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/PassRate)
(Facoltativo)
Specifica la percentuale di test in un rapporto di test che deve essere superata affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono numeri decimali. Ad esempio, 50, 60.5. I criteri della percentuale di superamento vengono applicati solo ai report dei test. Per ulteriori informazioni sui rapporti di prova, vedereReport sui test.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Percentuale di superamento
LineCoverage
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/LineCoverage)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/LineCoverage)
(Facoltativo)
Specifica la percentuale di righe in un rapporto sulla copertura del codice che devono essere coperte affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono 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 report sulla copertura del codice, vedereReport di copertura del codice.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Copertura della linea
BranchCoverage
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/BranchCoverage)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/BranchCoverage)
(Facoltativo)
Specifica la percentuale di filiali in un rapporto sulla copertura del codice che deve essere coperta affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. I valori validi includono 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 report sulla copertura del codice, vedereReport di copertura del codice.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Copertura delle filiali
Vulnerabilità
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/Vulnerabilities)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/Vulnerabilities)
(Facoltativo)
Specifica il numero massimo e la gravità delle vulnerabilità consentite nel rapporto SCA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. 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 scegli
HIGH, verrannoHIGHCRITICALconteggiate le vulnerabilità. -
Il numero massimo di vulnerabilità della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che la CodeCatalyst segnalazione venga contrassegnata come non riuscita. 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 gravità minima, utilizzare la Severity proprietà. Per specificare il numero massimo di vulnerabilità, utilizzare la Number proprietà.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Vulnerabilità
StaticAnalysisBug
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisBug)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisBug)
(Facoltativo)
Specifica il numero massimo e la gravità dei bug consentiti nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare i bug, è necessario specificare:
-
La gravità minima dei bug da includere nel conteggio. I valori validi, dal più grave al meno grave, sono:
CRITICALHIGH,,MEDIUM,LOW,INFORMATIONAL.Ad esempio, se lo desideri
HIGH, verrannoHIGHconteggiati iCRITICALbug. -
Il numero massimo di bug della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che la CodeCatalyst segnalazione venga contrassegnata come non riuscita. I valori validi sono numeri interi.
I criteri relativi ai bug vengono applicati solo ai PyLint report di ESLint SA. Per ulteriori informazioni sui report SA, vedere. Rapporti di analisi statica
Per specificare la gravità minima, utilizzare la Severity proprietà. Per specificare il numero massimo di vulnerabilità, utilizzare la Number proprietà.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Bug
StaticAnalysisSecurity
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisSecurity)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisSecurity)
(Facoltativo)
Specifica il numero massimo e la gravità delle vulnerabilità di sicurezza consentite nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare le vulnerabilità di sicurezza, è necessario specificare:
-
La gravità minima delle vulnerabilità di sicurezza che desideri includere nel conteggio. I valori validi, dal più grave al meno grave, sono:
CRITICAL,HIGH,,MEDIUMLOW,INFORMATIONAL.Ad esempio, se si sceglie
HIGH, verrannoHIGHconteggiate le vulnerabilità diCRITICALsicurezza. -
Il numero massimo di vulnerabilità di sicurezza della gravità specificata che desideri consentire. Il superamento di questo numero fa sì che il CodeCatalyst rapporto venga contrassegnato come non riuscito. I valori validi sono numeri interi.
I criteri relativi alle vulnerabilità di sicurezza vengono applicati solo ai report PyLint di ESLint SA. Per ulteriori informazioni sui report SA, vedere. Rapporti di analisi statica
Per specificare la gravità minima, utilizzare la Severity proprietà. Per specificare il numero massimo di vulnerabilità, utilizzare la Number proprietà.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Vulnerabilità di sicurezza
StaticAnalysisQuality
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisQuality)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisQuality)
(Facoltativo)
Specifica il numero massimo e la gravità dei problemi di qualità consentiti nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare i problemi di qualità, è necessario specificare:
-
La gravità minima dei problemi di qualità da includere nel conteggio. I valori validi, dal più grave al meno grave, sono:
CRITICALHIGH,,MEDIUM,LOW,INFORMATIONAL.Ad esempio, se scegli
HIGH, verrannoHIGHconteggiati i problemi diCRITICALqualità. -
Il numero massimo di problemi di qualità della gravità specificata che si desidera consentire. Il superamento di questo numero fa sì che il CodeCatalyst rapporto venga contrassegnato come non riuscito. I valori validi sono numeri interi.
I criteri relativi ai problemi di qualità vengono applicati solo ai PyLint report di ESLint SA. Per ulteriori informazioni sui report SA, vedere. Rapporti di analisi statica
Per specificare la gravità minima, utilizzare la Severity proprietà. Per specificare il numero massimo di vulnerabilità, utilizzare la Number proprietà.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Problemi di qualità
StaticAnalysisFinding
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisFinding)
Or
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisFinding)
(Facoltativo)
Specifica il numero massimo e la gravità dei risultati consentiti nel rapporto SA affinché il CodeCatalyst rapporto associato venga contrassegnato come superato. Per specificare i risultati, è necessario specificare:
-
La gravità minima dei risultati da includere nel conteggio. I valori validi, dal più elevato al meno severo, sono:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Ad esempio, se scegli
HIGH,HIGHiCRITICALrisultati verranno conteggiati. -
Il numero massimo di rilevazioni della gravità specificata che desideri autorizzare. Il superamento di questo numero fa sì che il CodeCatalyst rapporto venga contrassegnato come non riuscito. I valori validi sono numeri interi.
I risultati si applicano solo alle segnalazioni SARIF SA. Per ulteriori informazioni sui rapporti SA, vedereRapporti di analisi statica.
Per specificare la gravità minima, utilizzare la Severity proprietà. Per specificare il numero massimo di vulnerabilità, utilizzare la Number proprietà.
Interfaccia utente corrispondente: tab/Reports Output/Criteri di successo/ Risultati
Report
(action-name/Outputs/Reports )
(Facoltativo)
Una sezione che specifica la configurazione per i report di test.
Interfaccia utente corrispondente: scheda Output/Rapporti
nome-rapporto 1
(nome-segnalazione-1) action-name /Outputs/Reports/
(Obbligatorio se è incluso) Report
Il nome che vuoi dare al CodeCatalyst report che verrà generato dai tuoi report non elaborati.
Interfaccia utente corrispondente: Outputs/Configurazione tab/Reports manuale dei rapporti/ Nome del rapporto
Formato
(action-name/Outputs/Reports/report-name-1/Format)
(Obbligatorio se è incluso) Report
Specifica il formato di file che utilizzi per i report. I valori possibili sono i seguenti.
-
Per i rapporti di prova:
-
Per Cucumber JSON, specifica Cucumber (editor visuale) o
CUCUMBERJSON(editor YAML). -
Per JUnit XML, specifica JUnit (editor visuale) o (editor YAML).
JUNITXML -
Per NUnit XML, specificare NUnit (editor visuale) o (editor YAML).
NUNITXML -
Per NUnit 3 XML, specificare NUnit3 (editor visuale) o (editor YAML).
NUNIT3XML -
Per Visual Studio TRX, specificare Visual Studio TRX (editor visivo) o
VISUALSTUDIOTRX(editor YAML). -
Per TestNG XML, specifica TestNG (editor visuale) o (editor YAML).
TESTNGXML
-
-
Per i report sulla copertura del codice:
-
Per Clover XML, specifica Clover (editor visuale) o
CLOVERXML(editor YAML). -
Per Cobertura XML, specifica Cobertura (editor visuale) o (editor YAML).
COBERTURAXML -
Per JaCoCo XML, specificare JaCoCo (editor visuale) o (editor YAML).
JACOCOXML -
Per SimpleCov JSON generato da simplecov
, non da simplecov-json, specifica Simplecov (editor visuale) o ( editor YAML). SIMPLECOV
-
-
Per i report di analisi della composizione del software (SCA):
-
Per SARIF, specificare SARIF (editor visuale) o
SARIFSCA(editor YAML).
-
Interfaccia utente corrispondente: Outputs tab/Reports /Manually configure /configure reports// reports/Add/Tipo e formato del report report-name-1
Configurazione
(action-name/Configuration)
(Obbligatorio) Una sezione in cui è possibile definire le proprietà di configurazione dell'azione.
Interfaccia utente corrispondente: scheda Configurazione
Contenitore
(action-name/Configuration/Container)
(Facoltativo)
Specifica l'immagine Docker, o contenitore, che l'azione utilizza per completarne l'elaborazione. Puoi specificare una delle immagini attive in CodeCatalyst dotazione oppure puoi usare la tua immagine. Se scegli di utilizzare la tua immagine, può risiedere in Amazon ECR, Docker Hub o in un altro registro. Se non specifichi un'immagine Docker, l'azione utilizza una delle immagini attive per la sua elaborazione. Per informazioni su quale immagine attiva viene utilizzata per impostazione predefinita, consultaImmagini attive.
Per ulteriori informazioni su come specificare la propria immagine Docker, consulta. Assegnazione di un'immagine Docker in un ambiente di runtime personalizzato a un'azione
Interfaccia utente corrispondente: immagine Docker dell'ambiente di runtime - opzionale
Registro
(action-name/Configuration/Container/Registry)
(Obbligatorio se Container è incluso)
Specifica il registro in cui è archiviata l'immagine. I valori validi includono:
-
CODECATALYST(Editor YAML)L'immagine è memorizzata nel registro. CodeCatalyst
-
Docker Hub (editor visuale) o
DockerHub(editor YAML)L'immagine è memorizzata nel registro delle immagini di Docker Hub.
-
Altro registro (editor visuale) o
Other(editor YAML)L'immagine è memorizzata in un registro di immagini personalizzato. È possibile utilizzare qualsiasi registro disponibile al pubblico.
-
Amazon Elastic Container Registry (editor visuale) o
ECR(editor YAML)L'immagine è archiviata in un repository di immagini di Amazon Elastic Container Registry. Per utilizzare un'immagine in un repository Amazon ECR, questa azione richiede l'accesso ad Amazon ECR. Per abilitare questo accesso, devi creare un ruolo IAM che includa le seguenti autorizzazioni e una politica di fiducia personalizzata. (Puoi modificare un ruolo esistente per includere le autorizzazioni e la policy, se lo desideri).
Il ruolo IAM deve includere le seguenti autorizzazioni nella sua politica di ruolo:
-
ecr:BatchCheckLayerAvailability -
ecr:BatchGetImage -
ecr:GetAuthorizationToken -
ecr:GetDownloadUrlForLayer
Il ruolo IAM deve includere la seguente politica di fiducia personalizzata:
Per ulteriori informazioni sulla creazione di ruoli IAM, consulta Creazione di un ruolo utilizzando politiche di fiducia personalizzate (console) nella IAM User Guide.
Una volta creato il ruolo, è necessario assegnarlo all'azione tramite un ambiente. Per ulteriori informazioni, consulta Associare un ambiente a un'azione.
-
Interfaccia utente corrispondente: Amazon Elastic Container Registry, Docker Hub e altre opzioni di registro
Immagine
(action-name/Configuration/Container/Image)
(Obbligatorio se Container è incluso)
Specifica una delle seguenti proprietà:
-
Se utilizzi un
CODECATALYSTregistro, imposta l'immagine su una delle seguenti immagini attive:-
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
-
-
Se stai utilizzando un registro Docker Hub, imposta l'immagine sul nome dell'immagine Docker Hub e sul tag opzionale.
Ad esempio:
postgres:latest -
Se utilizzi un registro Amazon ECR, imposta l'immagine sull'URI del registro Amazon ECR.
Ad esempio:
111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo -
Se utilizzi un registro personalizzato, imposta l'immagine sul valore previsto dal registro personalizzato.
Interfaccia utente corrispondente: immagine docker dell'ambiente di runtime (se il registro èCODECATALYST), immagine Docker Hub (se il registro è Docker Hub), URL dell'immagine ECR (se il registro è Amazon Elastic Container Registry) e URL dell'immagine (se il registro è Altro registro).
Fasi
(action-name/Configuration/Steps)
(Obbligatorio)
Specifica i comandi della shell da eseguire durante l'azione di installazione, configurazione ed esecuzione degli strumenti di compilazione.
Ecco un esempio di come creare un progetto npm:
Steps:
- Run: npm install
- Run: npm run build
Ecco un esempio di come specificare i percorsi dei 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
Per ulteriori informazioni sulla specificazione dei percorsi dei file, vedere Riferimento ai file del repository di origine eRiferimento ai file in un artefatto.
Interfaccia utente corrispondente: scheda di configurazione/ comandi Shell
Pacchetti
(action-name/Configuration/Packages)
(Facoltativo)
Una sezione in cui è possibile specificare un repository di pacchetti che l'azione utilizza per risolvere le dipendenze. I pacchetti consentono di archiviare e condividere in modo sicuro i pacchetti software utilizzati per lo sviluppo di applicazioni.
Per ulteriori informazioni sui pacchetti, vederePubblica e condividi pacchetti software in CodeCatalyst.
Interfaccia utente corrispondente: scheda di configurazione/ pacchetti
NpmConfiguration
(action-name/Configuration/Packages/NpmConfiguration)
(Obbligatorio se Pacchetti è incluso)
Una sezione che definisce la configurazione per il formato del pacchetto npm. Questa configurazione viene utilizzata da un'azione durante l'esecuzione di un flusso di lavoro.
Per ulteriori informazioni sulla configurazione del pacchetto npm, vedereUtilizzo di npm.
Interfaccia utente corrispondente: tab/Packages Configurazione/Aggiungi configurazione/ npm
PackageRegistries
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries)
(Obbligatorio se è incluso) Pacchetti
Una sezione in cui è possibile definire le proprietà di configurazione di una sequenza di repository di pacchetti.
Interfaccia utente corrispondente: Configurazione tab/Packages configuration/npm /Aggiungi/Aggiungi repository di pacchetti
PackagesRepository
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/PackagesRepository)
(Obbligatorio se Pacchetti è incluso)
Specificate il nome del repository di CodeCatalyst pacchetti che desiderate utilizzare con l'azione.
Se si specificano più repository predefiniti, l'ultimo repository avrà la priorità.
Per ulteriori informazioni sui repository dei pacchetti, vedere. Repository di pacchetti
Interfaccia utente corrispondente: Configurazione tab/Packages /Add /Add package configuration/npm repository/ Package repository
Ambiti
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/Scopes)
(Facoltativo)
Specificate una sequenza di ambiti da definire nel registro dei pacchetti. Quando si definiscono gli ambiti, l'archivio dei pacchetti specificato viene configurato come registro per tutti gli ambiti elencati. Se un pacchetto con l'ambito viene richiesto tramite il client npm, utilizzerà quel repository anziché quello predefinito. Il nome di ogni ambito deve essere preceduto da «@».
Se includi gli ambiti sovrascritti, l'ultimo repository avrà la priorità.
Se Scopes viene omesso, il repository di pacchetti specificato viene configurato come registro predefinito per tutti i pacchetti utilizzati dall'azione.
Per ulteriori informazioni sugli ambiti, vedere namespace dei pacchetti e pacchetti Scoped.
Interfaccia utente corrispondente: Configurazione tab/Packages /Add /Add package configuration/npm repository/ Scopes - opzionale
ExportAuthorizationToken
(action-name/Configuration/Packages/ExportAuthorizationToken)
(Facoltativo)
Abilita o disabilita la funzionalità del token di autorizzazione all'esportazione. Se abilitati, i token di autorizzazione esportati possono essere utilizzati per configurare manualmente un gestore di pacchetti per l'autenticazione con CodeCatalyst i repository di pacchetti. Puoi usare il token come variabile di ambiente a cui puoi fare riferimento nelle tue azioni.
I valori validi sono true e false.
Se ExportAuthorizationToken viene omesso, l'impostazione predefinita è. false
Per ulteriori informazioni sul token di autorizzazione all'esportazione, vedereUtilizzo dei token di autorizzazione nelle azioni del flusso di lavoro.
Interfaccia utente corrispondente: token di autorizzazione alla tab/Packages configurazione/esportazione