Azioni di creazione e test YAML - Amazon CodeCatalyst
nome dell'azioneIdentifierDependsOnComputeTypeFleetTimeoutEnvironmentNameConnectionsNameRoleCachingFileCachingnome-chiave 1PathRestoreKeysInputsSourcesArtifacts - inputVariables - inputOutputsArtifacts - outputNameFilesVariables - outputnome-variabile-1AutoDiscoverReportsEnabledReportNamePrefixIncludePathsExcludePathsSuccessCriteriaPassRateLineCoverageBranchCoverageVulnerabilitiesStaticAnalysisBugStaticAnalysisSecurityStaticAnalysisQualityStaticAnalysisFindingReportsnome-rapporto-1FormatConfigurationContainerRegistryImageStepsPackagesNpmConfigurationPackageRegistriesPackagesRepositoryScopesExportAuthorizationToken

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à.

Azioni di creazione e test YAML

Di seguito è riportata la YAML definizione delle azioni di compilazione e test. Esiste un riferimento per due azioni perché le loro YAML proprietà 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 YAMLDefinizione del workflow.

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

Nota

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

# 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/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 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 dell'azione

Identifier

(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.

Da utilizzare aws/build@v1 per le azioni di compilazione.

Utilizzare aws/managed-test@v1 per azioni di test.

Interfaccia utente corrispondente: diagramma di workwork/action-name/aws/build@v1|aws/managed-test@v1 etichetta

DependsOn

(action-name/DependsOn)

(Facoltativo)

Specificate un'azione, un gruppo di azioni o un gate che deve essere eseguito correttamente per l'esecuzione di questa azione.

Per ulteriori informazioni sulla funzionalità «dipende da», vedere. Azioni di sequenziamento

Interfaccia utente corrispondente: scheda Ingressi/Dipende da - opzionale

Compute

(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

Type

(action-name/Compute/Tipo)

(Obbligatorio se Compute incluso)

Il tipo di motore di calcolo. È possibile utilizzare uno dei seguenti valori:

  • EC2(editor visivo) o EC2 (YAMLeditor)

    Ottimizzato per la flessibilità durante le sessioni di azione.

  • Lambda (editor visivo) o Lambda (YAMLeditor)

    Velocità di avvio dell'azione ottimizzate.

Per ulteriori informazioni sui tipi di calcolo, consulta Tipi di calcolo.

Interfaccia utente corrispondente: scheda di configurazione/tipo di calcolo

Fleet

(action-name/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

Timeout

(action-name/Timeout)

(Facoltativo)

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

Interfaccia utente corrispondente: scheda di configurazione/timeout - opzionale

Environment

(action-name/Environment)

(Facoltativo)

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

Nota

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

Per ulteriori informazioni sugli ambienti, vedere Implementazione in e Account AWS VPCs eCreazione di un ambiente.

Interfaccia utente corrispondente: scheda di configurazione/ambiente

Name

(action-name/Environment/Name)

(Facoltativo)

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

Interfaccia utente corrispondente: scheda di configurazione/ambiente

Connections

(action-name/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 IAM ruolo predefinito specificati nell'ambiente della CodeCatalyst console. Per informazioni sull'aggiunta di una connessione all'account e di un IAM ruolo predefinito all'ambiente, consultaCreazione di un ambiente.

  • Il IAM ruolo 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 sulla YAML definizione dell'azione.

Per ulteriori informazioni sulle connessioni degli account, vedereConsentire 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: la configurazione tab/Environment/What è attiva my-environment? /menu a tre punti/ Cambia ruolo

Name

(action-name/Environment/Connections/Name)

(Obbligatorio se inclusoConnections)

Specificare il nome della connessione all'account.

Interfaccia utente corrispondente: la configurazione tab/Environment/What è attiva my-environment? /menu a tre punti/ Cambia ruolo

Role

(action-name/Environment/Connections/Role)

(Obbligatorio se inclusoConnections)

Specificare il nome del IAM ruolo 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 IAM ruolo alla connessione di un account, vediAggiungere IAM ruoli alle connessioni degli account.

Se non specifichi un IAM ruolo, l'azione utilizza il IAM ruolo predefinito elencato nell'ambiente della 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 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: la configurazione tab/Environment/What è attiva 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: scheda di configurazione/memorizzazione nella cache dei file - opzionale/Aggiungi cache

nome-chiave 1

(action-name/Caching/FileCaching/key-name-1)

(Facoltativo)

Specificate 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 immissioniFileCaching.

Interfaccia utente corrispondente: tab/File caching - optional/Add cache di configurazione/chiave

Path

(action-name/Caching/FileCaching/key-name-1/Path)

(Facoltativo)

Specificate il percorso associato per la cache.

Interfaccia utente corrispondente: tab/File caching - optional/Add cache/percorso di configurazione

RestoreKeys

(action-name/Caching/FileCaching/key-name-1/RestoreKeys)

(Facoltativo)

Specificare la chiave di ripristino da utilizzare come fallback quando non è possibile trovare la proprietà della cache principale. 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 caching - optional/Add cache di configurazione/chiavi di ripristino - opzionale

Inputs

(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 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, consultare Esempio: riferimento a file in più artefatti.

Interfaccia utente corrispondente: scheda Ingressi

Sources

(action-name/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 degli archivi di origine ai flussi di lavoro.

Interfaccia utente corrispondente: nessuna

Artifacts - input

(action-name/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 artefatti e file tra azioni

Nota

Se l'elenco a discesa Artifacts - opzionale non è disponibile (editor visivo) o se si verificano errori durante la convalida del YAML (YAMLeditor), è 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

(action-name/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, vedereUtilizzo delle variabili nei flussi di lavoro.

Interfaccia utente corrispondente: scheda Input/Variabili - opzionale

Outputs

(action-name/Outputs)

(Facoltativo)

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

Interfaccia utente corrispondente: scheda Output

Artifacts - output

(action-name/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 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 esempi, vedere. Condivisione di artefatti e file tra azioni

Interfaccia utente corrispondente: scheda Outputs/Artifacts

Name

(action-name/Outputs/Artifacts/Name)

(Richiesto se incluso) Artifacts - output

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 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 esempi, vedere. Condivisione di artefatti e file tra azioni

Interfaccia utente corrispondente: restituisce il nome dell'output/build dell'tab/Artifacts/Newartefatto

Files

(action-name/Outputs/Artifacts/Files)

(Obbligatorio se incluso) Artifacts - 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 artefatti e file tra azioni

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 del repository di origine e Riferimento ai file in un artefatto.

Interfaccia utente corrispondente: output in output/file prodotti tab/Artifacts/New da build

Variables - output

(action-name/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, vedereUtilizzo delle variabili nei flussi di lavoro.

Interfaccia utente corrispondente: scheda Output/Variabili/ Aggiungi variabile

nome-variabile-1

(action-name/Outputs/Variables/variable-name-1)

(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, vedereUtilizzo delle variabili nei flussi di lavoro.

Interfaccia utente corrispondente: tab/Variables/Add variabile/nome degli output

AutoDiscoverReports

(action-name/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: scheda Outputs/Rapports/Auto-discover reports

Enabled

(action-name/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/ Auto-discover reports

ReportNamePrefix

(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)

(Richiesto se è incluso e abilitato) AutoDiscoverReports

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 Outputs/Reports/ Nome del prefisso

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

Or

(action-name/Outputs/Reports/report-name-1/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:

  • Percorsi di tab/Reports/Auto-discover reports/Include/exclude uscita/percorsi di inclusione

  • Gli output configurano i report/ tab/Reports/Manuallyreport-name-1/Includi/escludi percorsi/ Includi percorsi

ExcludePaths

(action-name/Outputs/AutoDiscoverReports/ExcludePaths)

Or

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

(Facoltativo)

Specificate i file e i percorsi dei file da CodeCatalyst escludere durante la 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

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

Interfaccia utente corrispondente:

  • Percorsi di tab/Reports/Auto-discover reports/Include/exclude uscita/percorsi di esclusione

  • Gli output configurano i report/ tab/Reports/Manuallyreport-name-1/Includi/escludi percorsi/ Escludi percorsi

SuccessCriteria

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)

Or

(action-name/Outputs/Reports/report-name-1/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/Criteri di successo

PassRate

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/PassRate)

Or

(action-name/Outputs/Reports/report-name-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: tab/Reports/Success criteri di uscita/velocità di passaggio

LineCoverage

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/LineCoverage)

Or

(action-name/Outputs/Reports/report-name-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: tab/Reports/Success criteri di uscita/copertura di linea

BranchCoverage

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/BranchCoverage)

Or

(action-name/Outputs/Reports/report-name-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 superato. 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: tab/Reports/Success criteri di uscita/copertura delle filiali

Vulnerabilities

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/Vulnerabilities)

Or

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/Vulnerabilities)

(Facoltativo)

Specificare il numero e la gravità massimi di vulnerabilità consentiti nel SCA rapporto 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 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 SCA report. Per ulteriori informazioni sui SCA report, vedereRapporti 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à.

Interfaccia utente corrispondente: tab/Reports/Success criteri di uscita/vulnerabilità

StaticAnalysisBug

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisBug)

Or

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisBug)

(Facoltativo)

Specificate il numero e la gravità massimi di 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:CRITICAL,HIGH,, MEDIUMLOW,INFORMATIONAL.

    Ad esempio, se scegliHIGH, allora HIGH i CRITICAL bug verranno conteggiati.

  • Il numero massimo di bug 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 relativi ai bug vengono applicati solo ai report PyLint e ESLint SA. Per ulteriori informazioni sui report SA, vedereRapporti di analisi statica.

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

Interfaccia utente corrispondente: tab/Reports/Success criteri di uscita/bug

StaticAnalysisSecurity

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisSecurity)

Or

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisSecurity)

(Facoltativo)

Specificate il numero e la gravità massimi di 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 da includere nel conteggio. I valori validi, dal più grave al meno grave, sono:CRITICAL,HIGH,, MEDIUMLOW,INFORMATIONAL.

    Ad esempio, se lo desideriHIGH, verranno HIGH conteggiate le vulnerabilità di CRITICAL sicurezza.

  • 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 fallito. I valori validi sono numeri interi.

I criteri di vulnerabilità di sicurezza vengono applicati solo ai report PyLint e ESLint SA. Per ulteriori informazioni sui report SA, vedereRapporti di analisi statica.

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

Interfaccia utente corrispondente: tab/Reports/Success criteri di uscita/vulnerabilità di sicurezza

StaticAnalysisQuality

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisQuality)

Or

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisQuality)

(Facoltativo)

Specificate il numero e la gravità massimi 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 si sceglieHIGH, verranno presi HIGH in CRITICAL considerazione i problemi di qualità.

  • 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 fallito. I valori validi sono numeri interi.

I criteri relativi ai problemi di qualità vengono applicati solo PyLint ai report ESLint SA. Per ulteriori informazioni sui report SA, vedereRapporti di analisi statica.

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

Interfaccia utente corrispondente: tab/Reports/Success criteri di uscita/problemi di qualità

StaticAnalysisFinding

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisFinding)

Or

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisFinding)

(Facoltativo)

Specificare il numero e la gravità massimi 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ù grave al meno severo, sono: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

    Ad esempio, se scegliHIGH, allora HIGH i CRITICAL risultati verranno conteggiati.

  • Il numero massimo di risultati 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 risultati si applicano solo ai rapporti SARIF SA. Per ulteriori informazioni sui rapporti SA, vedereRapporti di analisi statica.

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

Interfaccia utente corrispondente: tab/Reports/Success criteri di uscita/risultati

Reports

(action-name/Outputs/Reports )

(Facoltativo)

Una sezione che specifica la configurazione per i rapporti di prova.

Interfaccia utente corrispondente: scheda Output/Report

nome-rapporto-1

(action-name/Outputs/Reports/nome-relazione-1)

(Obbligatorio se incluso) Reports

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

Interfaccia utente corrispondente: Outputs tab/Reports/Manually configura report/nome del report

Format

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

(Obbligatorio se inclusoReports)

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

  • Per i rapporti sui test:

    • Per CucumberJSON, specifica Cucumber (editor visuale) o CUCUMBERJSON (YAMLeditor).

    • Per JUnitXML, specifica JUnit(editor visivo) o JUNITXML (YAMLeditor).

    • Per NUnitXML, specifica NUnit(editor visivo) o NUNITXML (YAMLeditor).

    • Per NUnit 3XML, specifica NUnit3(editor visivo) o NUNIT3XML (YAMLeditor).

    • Per Visual StudioTRX, specifica Visual Studio TRX (editor visivo) o VISUALSTUDIOTRX (YAMLeditor).

    • Per TestNgXML, specifica TestNg (editor visivo) o TESTNGXML (editor). YAML

  • Per i report sulla copertura del codice:

    • Per CloverXML, specifica Clover (editor visivo) o CLOVERXML (YAMLeditor).

    • Per CoberturaXML, specifica Cobertura (editor visivo) o (editor). COBERTURAXML YAML

    • Per JaCoCo XML, specifica JaCoCo(editor visivo) o JACOCOXML (editor). YAML

    • Per SimpleCov JSON generato da simplecov, non da simplecov-json, specifica Simplecov (editor visivo) o (editor). SIMPLECOV YAML

  • Per i report sull'analisi della composizione del software (): SCA

    • PerSARIF, specificare SARIF(editor visivo) o SARIFSCA (YAMLeditor).

Interfaccia utente corrispondente: restituisce i reports/ tab/Reports/Manually configure reports/Add/configurereport-name-1/Tipo di rapporto e formato del rapporto

Configuration

(action-name/Configuration)

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

Interfaccia utente corrispondente: scheda Configurazione

Container

(action-name/Configuration/Container)

(Facoltativo)

Specificate l'immagine Docker, o contenitore, che l'azione utilizza per completare l'elaborazione. È possibile specificare una delle immagini attive fornite in CodeCatalyst dotazione oppure utilizzare un'immagine personalizzata. Se scegli di utilizzare la tua immagine, può risiedere in AmazonECR, Docker Hub o in un altro registro. Se non specifichi un'immagine Docker, l'azione utilizza una delle immagini attive per l'elaborazione. Per informazioni su quale immagine attiva viene utilizzata per impostazione predefinita, consultaImmagini attive.

Per ulteriori informazioni su come specificare un'immagine Docker personalizzata, consulta. Assegnazione di un'immagine Docker in un ambiente di runtime personalizzato a un'azione

Interfaccia utente corrispondente: immagine Docker dell'ambiente di esecuzione - opzionale

Registry

(action-name/Configuration/Container/Registry)

(Obbligatorio se Container incluso)

Specificate il registro in cui è archiviata l'immagine. I valori validi includono:

  • CODECATALYST(YAMLeditor)

    L'immagine viene memorizzata nel CodeCatalyst registro.

  • Docker Hub (editor visivo) o DockerHub (YAMLeditor)

    L'immagine è memorizzata nel registro delle immagini di Docker Hub.

  • Altro registro (editor visivo) o Other (YAMLeditor)

    L'immagine viene memorizzata in un registro di immagini personalizzato. È possibile utilizzare qualsiasi registro disponibile pubblicamente.

  • Amazon Elastic Container Registry (editor visivo) o ECR (YAMLeditor)

    L'immagine è archiviata in un repository di immagini di Amazon Elastic Container Registry. Per utilizzare un'immagine in un ECR repository Amazon, questa azione richiede l'accesso ad AmazonECR. Per abilitare questo accesso, devi creare un IAMruolo che includa le seguenti autorizzazioni e una politica di fiducia personalizzata. (Se lo desideri, puoi modificare un ruolo esistente per includere le autorizzazioni e la politica.)

    Il IAM ruolo deve includere le seguenti autorizzazioni nella sua politica del ruolo:

    • ecr:BatchCheckLayerAvailability

    • ecr:BatchGetImage

    • ecr:GetAuthorizationToken

    • ecr:GetDownloadUrlForLayer

    Il IAM ruolo deve includere la seguente politica di fiducia personalizzata:

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

    Per ulteriori informazioni sulla creazione di IAM ruoli, vedere Creazione di un ruolo utilizzando criteri di fiducia personalizzati (console) nella Guida per l'IAMutente.

    Dopo aver 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

Image

(action-name/Configuration/Container/Image)

(Obbligatorio se Container incluso)

Specifica una delle seguenti proprietà:

  • Se utilizzate un CODECATALYST registro, impostate 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 utilizzi un registro Docker Hub, imposta l'immagine sul nome dell'immagine Docker Hub e sul tag opzionale.

    Esempio: postgres:latest

  • Se utilizzi un ECR registro Amazon, imposta l'immagine sul ECR registro AmazonURI.

    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), ECRimmagine URL (se il registro è Amazon Elastic Container Registry) e immagine URL (se il registro è Altro registro).

Steps

(action-name/Configuration/Steps)

(Obbligatorio)

Specificate i comandi di shell da eseguire durante l'operazione 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

Packages

(action-name/Configuration/Packages)

(Facoltativo)

Una sezione in cui è possibile specificare un archivio di pacchetti utilizzato dall'azione 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)

(Richiesto se Packages 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: Configuration tab/Packages/Add configuration/ npm

PackageRegistries

(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries)

(Richiesto se inclusoPackages)

Una sezione in cui è possibile definire le proprietà di configurazione di una sequenza di repository di pacchetti.

Interfaccia utente corrispondente: tab/Packages/Add configuration/npm Configurazione/Aggiungi archivio di pacchetti

PackagesRepository

(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/PackagesRepository)

(Richiesto se Packages incluso)

Specificate il nome dell'archivio dei CodeCatalyst pacchetti che desiderate venga utilizzato dall'azione.

Se specificate più repository predefiniti, l'ultimo repository avrà la priorità.

Per ulteriori informazioni sugli archivi dei pacchetti, vedere. Archivi di pacchetti

Interfaccia utente corrispondente: archivio dei tab/Packages/Add configuration/npm/Add pacchetti di configurazione/archivio dei pacchetti

Scopes

(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/Scopes)

(Facoltativo)

Specificate una sequenza di ambiti che desiderate 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. Ogni nome di ambito deve avere il prefisso «@».

Se includi gli ambiti di override, l'ultimo repository avrà la priorità.

Se Scopes viene omesso, l'archivio dei pacchetti specificato viene configurato come registro predefinito per tutti i pacchetti utilizzati dall'azione.

Per ulteriori informazioni sugli ambiti, vedere i pacchetti and Namespace dei pacchetti Scoped.

Interfaccia utente corrispondente: repository/ Scopes dei tab/Packages/Add configuration/npm/Add pacchetti di configurazione - opzionale

ExportAuthorizationToken

(action-name/Configuration/Packages/ExportAuthorizationToken)

(Facoltativo)

Abilita o disabilita la funzionalità del token di autorizzazione all'esportazione. Se abilitata, i token di autorizzazione esportati possono essere utilizzati per configurare manualmente un gestore di pacchetti per l'autenticazione con CodeCatalyst gli archivi di pacchetti. È possibile utilizzare il token come variabile di ambiente a cui fare riferimento nelle proprie 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: scheda di configurazione/Pacchetti/ Token di autorizzazione all'esportazione