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

YAMLDefinizione del workflow

Di seguito è riportata la documentazione di riferimento per il file di definizione del flusso di lavoro.

Un file di definizione del flusso di lavoro è un YAML file che descrive il flusso di lavoro. Per impostazione predefinita, il file viene archiviato in una ~/.codecatalyst/workflows/ cartella nella radice del repository di origine. Il file può avere un'estensione .yml o .yaml e l'estensione deve essere minuscola.

Per creare e modificare il file di definizione del flusso di lavoro, è possibile utilizzare un editor come vim oppure l'editor visuale o l'editor della console. CodeCatalyst YAML Per ulteriori informazioni, consulta Utilizzo della visualizzazione e degli YAML editor della CodeCatalyst console.

Esempio di file di definizione del flusso di lavoro

Di seguito è riportato un esempio di un semplice file di definizione del flusso di lavoro. Include alcune proprietà di primo livello, una Triggers sezione e una Actions sezione con due azioni: Build eTest. Per ulteriori informazioni, consulta Informazioni sul file di definizione del flusso di lavoro.

Name: MyWorkflow
SchemaVersion: 1.0
RunMode: QUEUED
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:     
      Steps:
        - Run: docker build -t MyApp:latest .
  Test:
    Identifier: aws/managed-test@v1
    DependsOn: 
      - Build
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
        - Run: npm install
        - Run: npm run test

Linee guida e convenzioni sulla sintassi

Questa sezione descrive le regole di sintassi per il file di definizione del flusso di lavoro, nonché le convenzioni di denominazione utilizzate in questa documentazione di riferimento.

YAMLlinee guida sulla sintassi

Il file di definizione del flusso di lavoro è scritto YAML e segue la specifica YAML 1.1, quindi tutto ciò che è consentito in tale specifica è consentito anche nel flusso di lavoroYAML. Se sei un principianteYAML, ecco alcune linee guida rapide per assicurarti di fornire YAML codice valido.

Convenzioni di denominazione

In questa guida, utilizziamo i termini proprietà e sezione per fare riferimento agli elementi principali di un file di definizione del flusso di lavoro.

Proprietà di primo livello

Di seguito è riportata la documentazione di riferimento per le proprietà di primo livello nel file di definizione del flusso di lavoro.

# Name
Name: workflow-name
        
# Schema version
SchemaVersion: 1.0
        
# Run mode
RunMode: QUEUED|SUPERSEDED|PARALLEL

# Compute
Compute:  
...
            
# Triggers
Triggers:
...

# Actions
Actions:
...

Name

(Obbligatorio)

Nome del flusso di lavoro. Il nome del flusso di lavoro viene visualizzato nell'elenco dei flussi di lavoro e menzionato nelle notifiche e nei registri. Il nome del flusso di lavoro e il nome del file di definizione del flusso di lavoro possono corrispondere oppure è possibile denominarli in modo diverso. I nomi dei flussi di lavoro non devono essere necessariamente univoci. I nomi dei flussi di lavoro 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 dei flussi di lavoro.

Interfaccia utente corrispondente: editor visivo/proprietà del workflow /nome del flusso di lavoro

SchemaVersion

(Obbligatorio)

La versione dello schema della definizione del flusso di lavoro. Attualmente, l'unico valore valido è 1.0.

Interfaccia utente corrispondente: nessuna

RunMode

(Facoltativo)

Come CodeCatalyst gestisce le esecuzioni multiple. È possibile utilizzare uno dei seguenti valori:

Se questa proprietà viene omessa, l'impostazione predefinita èQUEUED.

Per ulteriori informazioni, consulta Configurazione del comportamento di accodamento delle esecuzioni.

Interfaccia utente corrispondente: modalità editor/Workflow properties/Advanced visuale/Run

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.

Per ulteriori informazioni sull'elaborazione, consultaConfigurazione delle immagini di calcolo e di runtime.

Interfaccia utente corrispondente: nessuna

Name: MyWorkflow
SchemaVersion: 1.0
...
Compute:  
  Type: EC2 | Lambda
  Fleet: fleet-name
  SharedInstance: true | false

Type

(Compute/Type)

(Obbligatorio se Compute impostato)

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

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

Interfaccia utente corrispondente: tipo editor/Workflow properties/Advanced visivo/di calcolo

Fleet

(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

Per ulteriori informazioni sulle flotte di elaborazione, consulta. Flotte di calcolo

Interfaccia utente corrispondente: visual editor/Workflow properties/Advanced /Compute fleet

SharedInstance

(Compute/SharedInstance)

(Facoltativo)

Specificate la capacità di condivisione del calcolo per le vostre azioni. Con la condivisione del calcolo, le azioni in un flusso di lavoro vengono eseguite sulla stessa istanza (immagine dell'ambiente di runtime). È possibile utilizzare uno dei seguenti valori:

Per ulteriori informazioni sulla condivisione del calcolo, consulta. Condivisione dell'elaborazione tra le azioni

Interfaccia utente corrispondente: nessuna

Triggers

(Facoltativo)

Una sequenza di uno o più trigger per questo flusso di lavoro. Se non viene specificato un trigger, è necessario avviare manualmente il flusso di lavoro.

Per ulteriori informazioni sui trigger, consulta L'avvio di un flusso di lavoro viene eseguito automaticamente utilizzando i trigger.

Interfaccia utente corrispondente: editor visivo/diagramma del workflow /Triggers

Name: MyWorkflow
SchemaVersion: 1.0
...
Triggers:
  - Type: PUSH
    Branches:
      - branch-name
    FilesChanged:
      - folder1/file
      - folder2/
 
  - Type: PULLREQUEST
    Events:
      - OPEN
      - CLOSED
      - REVISION
    Branches:
      - branch-name
    FilesChanged:
      - file1.txt
      
  - Type: SCHEDULE
    # Run the workflow at 10:15 am (UTC+0) every Saturday
    Expression: "15 10 ? * 7 *"
    Branches:
      - branch-name

Type

(Triggers/Type)

(Obbligatorio se impostato) Triggers

Specificare il tipo di trigger. È possibile utilizzare uno dei seguenti valori:

Per alcuni esempi, consulta Esempi: trigger nei flussi di lavoro.

Interfaccia utente corrispondente: editor/workflow diagram/Triggers visuale/tipo di trigger

Events

(Triggers/Events)

(Richiesto se il trigger Type è impostato suPULLREQUEST)

Specificate il tipo di eventi di pull request che avvieranno l'esecuzione di un flusso di lavoro. Di seguito sono riportati i valori validi:

È possibile specificare più eventi nello stesso trigger di pull request.

Per alcuni esempi, consulta Esempi: trigger nei flussi di lavoro.

Interfaccia utente corrispondente: visualeditor/workflow diagram/Triggers/Events for pull request

Branches

(Triggers/Branches)

(Facoltativo)

Specificate i rami nel vostro repository di origine monitorati dal trigger per sapere quando avviare l'esecuzione di un flusso di lavoro. È possibile utilizzare modelli regex per definire i nomi delle filiali. Ad esempio, utilizzare per main.* abbinare tutti i rami che iniziano conmain.

I rami da specificare sono diversi a seconda del tipo di trigger:

Per ulteriori informazioni su rami e trigger, consulta. Linee guida per l'utilizzo di trigger e filiali

Per ulteriori esempi, consulta Esempi: trigger nei flussi di lavoro.

Interfaccia utente corrispondente: visualeditor/workflow diagram/Triggers/Branches

FilesChanged

(Triggers/FilesChanged)

(Facoltativo se il trigger Type è impostato suPUSH, oPULLREQUEST. Non supportato se il trigger Type è impostato suSCHEDULE.)

Specificate i file o le cartelle nell'archivio di origine monitorati dal trigger per sapere quando avviare l'esecuzione di un flusso di lavoro. È possibile utilizzare espressioni regolari per abbinare i nomi o i percorsi dei file.

Per alcuni esempi, consulta Esempi: trigger nei flussi di lavoro.

Interfaccia utente corrispondente: visualeditor/workflow diagram/Triggers/File modificati

Expression

(Triggers/Expression)

(Richiesto se il trigger Type è impostato suSCHEDULE)

Specificate l'espressione cron che descrive quando desiderate che avvenga l'esecuzione del flusso di lavoro pianificato.

Le espressioni Cron CodeCatalyst utilizzano la seguente sintassi a sei campi, in cui ogni campo è separato da uno spazio:

minutes hours days-of-month month days-of-week year

Esempi di espressioni cron

Quando specifichi le espressioni cron in CodeCatalyst, assicurati di seguire queste linee guida:

Per altri esempi di espressioni cron e informazioni sui caratteri jolly come, e ? *L, consulta il riferimento alle espressioni Cron nella Amazon EventBridge User Guide. Le espressioni Cron CodeCatalyst funzionano esattamente EventBridge allo stesso modo.

Per esempi di trigger di pianificazione, vedi. Esempi: trigger nei flussi di lavoro

Interfaccia utente corrispondente: visualeditor/workflow diagram/Triggers/Schedule

Azioni

Una sequenza di una o più azioni per questo flusso di lavoro. CodeCatalyst supporta diversi tipi di azioni, come azioni di compilazione e test, che offrono diversi tipi di funzionalità. Ogni tipo di azione ha:

Per ulteriori informazioni su ciascun tipo di azione, vedereTipi di operazione. L'Tipi di operazioneargomento contiene collegamenti alla documentazione relativa a ciascuna azione.

Di seguito è riportato il YAML riferimento per le azioni e i gruppi di azioni nel file di definizione del flusso di lavoro.

Name: MyWorkflow
SchemaVersion: 1.0
...
Actions:
  action-or-gate-name:
    Identifier: identifier
    Configuration:
    ...
  #Action groups
  action-group-name:
    Actions:
      ...

action-or-gate-name

(Actions/action-or-gate-name)

(Obbligatorio)

Replace (Sostituisci) action-name con il nome da assegnare all'azione. I nomi delle azioni devono essere univoci all'interno del flusso di lavoro e devono includere solo caratteri alfanumerici, trattini e caratteri di sottolineatura. Per ulteriori informazioni sulle regole di sintassi, vedere. YAMLlinee guida sulla sintassi

Per ulteriori informazioni sulle procedure di denominazione delle azioni, comprese le restrizioni, vedere. action-or-gate-name

Interfaccia utente corrispondente: visual editor/action-name/Scheda di configurazione/ Nome dell'azione o Nome visualizzato dell'azione

action-group-name

(Actions/action-group-name)

(Facoltativo)

Un gruppo di azioni contiene una o più azioni. Il raggruppamento delle azioni in gruppi di azioni consente di mantenere organizzato il flusso di lavoro e consente inoltre di configurare le dipendenze tra diversi gruppi.

Replace (Sostituisci) action-group-name con un nome che vuoi dare al gruppo di azioni. I nomi dei gruppi di azioni devono essere univoci all'interno del flusso di lavoro e devono includere solo caratteri alfanumerici, trattini e caratteri di sottolineatura. Per ulteriori informazioni sulle regole di sintassi, vedere. YAMLlinee guida sulla sintassi

Per ulteriori informazioni sui gruppi di azioni, vedereRaggruppamento delle azioni in gruppi di azione.

Interfaccia utente corrispondente: nessuna