Definição do YAML do fluxo de trabalho

Veja a seguir a documentação de referência do arquivo de definição do fluxo de trabalho.

Arquivo de definição de fluxo de trabalho é um arquivo YAML que descreve o fluxo de trabalho. Por padrão, o arquivo é armazenado em uma pasta ~/.codecatalyst/workflows/ na raiz do repositório de origem. O arquivo pode ter uma extensão .yml ou .yaml, e a extensão deve estar em minúsculas.

Para criar e editar o arquivo de definição de fluxo de trabalho, use um editor, como o vim, ou use o editor visual ou o editor YAML do console do CodeCatalyst. Para ter mais informações, consulte Usar os editores visual e YAML do console do CodeCatalyst.

Exemplo de um arquivo de definição de fluxo de trabalho

Veja a seguir um exemplo de um arquivo de definição de fluxo de trabalho simples. Inclui algumas propriedades de nível superior, uma seção Triggers e uma seção Actions com duas ações: Build e Test. Para ter mais informações, consulte Sobre o arquivo de definição do fluxo de trabalho.

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

Diretrizes e convenções de sintaxe

Esta seção descreve as regras de sintaxe para o arquivo de definição do fluxo de trabalho, bem como as convenções de nomenclatura usadas nesta documentação de referência.

Diretrizes de sintaxe do YAML

O arquivo de definição do fluxo de trabalho é escrito em YAML e segue a especificação YAML 1.1, portanto, tudo o que é permitido nessa especificação também é permitido no YAML do fluxo de trabalho. Se você for novo no YAML, aqui estão algumas diretrizes rápidas para garantir o fornecimento de um código YAML válido.

Convenções de nomenclatura

Neste guia, usamos os termos propriedade e seção para nos referirmos aos itens principais em um arquivo de definição de fluxo de trabalho.

Propriedades de nível superior

Veja a seguir a documentação de referência das propriedades de nível superior do arquivo de definição do fluxo de trabalho.

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

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

# Actions
Actions:
...

Name

(Obrigatório)

O nome do fluxo de trabalho. O nome do fluxo de trabalho é mostrado na lista de fluxos de trabalho e mencionado nas notificações e nos logs. O nome do fluxo de trabalho e o nome do arquivo de definição do fluxo de trabalho podem corresponder, ou você pode nomeá-los de forma diferente. Os nomes de fluxos de trabalho não precisam ser exclusivos. Os nomes de fluxos de trabalho são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (_). Não são permitidos espaços. Você não pode usar aspas para habilitar caracteres especiais e espaços nos nomes de fluxo de trabalho.

UI correspondente: editor visual/propriedades do fluxo de trabalho/nome do fluxo de trabalho

SchemaVersion

(Obrigatório)

A versão do esquema da definição do fluxo de trabalho. Atualmente, o único valor válido é 1.0.

Interface de usuário correspondente: nenhuma

RunMode

(Opcional)

Como o CodeCatalyst lida com várias execuções. É possível usar um dos seguintes valores:

Se essa propriedade for omitida, o padrão será QUEUED.

Para ter mais informações, consulte Configurar o comportamento de enfileiramento das execuções.

UI correspondente: editor visual/propriedades do fluxo de trabalho/Avançado/Modo de execução

Compute

(Opcional)

O mecanismo de computação usado para executar as ações de fluxo de trabalho. É possível especificar a computação em nível de fluxo de trabalho ou em nível de ação, mas não em ambos. Quando especificada em nível de fluxo de trabalho, a configuração de computação se aplica a todas as ações definidas no fluxo de trabalho. Em nível de fluxo de trabalho, também é possível realizar várias ações na mesma instância. Para ter mais informações, consulte Compartilhamento de computação entre ações.

Para ter mais informações sobre computação, consulte Configuração de imagens de computação e runtime.

Interface de usuário correspondente: nenhuma

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

Type

(Compute/Type)

(Necessário se Compute estiver definido)

O tipo do mecanismo de computação. É possível usar um dos seguintes valores:

Para obter informações sobre tipos de dados, consulte Tipos de computação.

UI correspondente: editor visual/propriedades do fluxo de trabalho/Avançado/Tipo de computação

Fleet

(Compute/Fleet)

(Opcional)

Especifique a máquina ou a frota que executará o fluxo de trabalho ou as ações de fluxo de trabalho. Com frotas sob demanda, quando uma ação é iniciada, o fluxo de trabalho provisiona os recursos necessários e as máquinas são destruídas quando a ação termina. Exemplos de frota sob demanda: Linux.x86-64.Large, Linux.x86-64.XLarge. Para ter mais informações sobre frotas sob demanda, consulte Propriedades da frota sob demanda.

Com frotas provisionadas, você configura um conjunto de máquinas dedicadas para realizar as ações do fluxo de trabalho. Essas máquinas permanecem ociosas, prontas para processar ações imediatamente. Para ter mais informações sobre frotas provisionadas, consulte Propriedades da frota provisionada.

Se Fleet for omitido, o padrão será Linux.x86-64.Large.

Para ter mais informações sobre frotas de computação, consulte Frotas de computação.

UI correspondente: editor visual/propriedades do fluxo de trabalho/Avançado/Frota de computação

SharedInstance

(Compute/SharedInstance)

(Opcional)

Especifique o recurso de compartilhamento de computação para suas ações. Com o compartilhamento de computação, as ações em um fluxo de trabalho são executadas na mesma instância (imagem do ambiente de runtime). É possível usar um dos seguintes valores:

Para ter mais informações sobre compartilhamento de computação, consulte Compartilhamento de computação entre ações.

Interface de usuário correspondente: nenhuma

Triggers

(Opcional)

Uma sequência de um ou mais gatilhos para esse fluxo de trabalho. Se um gatilho não for especificado, inicie manualmente seu fluxo de trabalho.

Para ter mais informações sobre gatilhos, consulte Início da execução automática de um fluxo de trabalho usando gatilhos.

UI correspondente: editor visual/diagrama de fluxo de trabalho/Gatilhos

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)

(Necessário se Triggers estiver definido)

Especifique o tipo de gatilho. É possível usar um dos seguintes valores:

Para ver exemplos, consulte Exemplos: gatilhos em fluxos de trabalho.

UI correspondente: editor visual/diagrama de fluxo de trabalho/Gatilhos/Tipo de gatilho

Events

(Triggers/Events)

(Obrigatório se o gatilho Type estiver definido como PULLREQUEST)

Especifique o tipo de eventos de solicitação pull que iniciarão a execução de um fluxo de trabalho. Os valores válidos são os seguintes:

Você pode especificar vários eventos no mesmo gatilho de solicitação pull.

Para ver exemplos, consulte Exemplos: gatilhos em fluxos de trabalho.

UI correspondente: editor visual/diagrama de fluxo de trabalho/Gatilhos/Eventos para solicitação pull

Branches

(Triggers/Branches)

(Opcional)

Especifique as ramificações em seu repositório de origem que o acionador monitora para saber quando iniciar a execução de um fluxo de trabalho. Você pode usar padrões regex para definir os nomes das ramificações. Por exemplo, use main.* para combinar todas as ramificações que começam com main.

As ramificações a serem especificadas são diferentes dependendo do tipo de gatilho:

Para ter mais informações sobre ramificações e gatilhos, consulte Diretrizes para o uso de gatilhos e ramificações.

Para obter mais exemplos, consulte Exemplos: gatilhos em fluxos de trabalho.

UI correspondente: editor visual/diagrama de fluxo de trabalho/Gatilhos/Ramificações

FilesChanged

(Triggers/FilesChanged)

(Opcional se o gatilho Type estiver definido como PUSH, ou PULLREQUEST. Não compatível se o gatilho Type estiver definido como SCHEDULE.)

Especifique os arquivos ou pastas em seu repositório de origem que o acionador monitora para saber quando iniciar a execução de um fluxo de trabalho. Você pode usar expressões regulares para corresponder nomes ou caminhos de arquivos.

Para ver exemplos, consulte Exemplos: gatilhos em fluxos de trabalho.

UI correspondente: editor visual/diagrama de fluxo de trabalho/Gatilhos/Arquivos alterados

Expression

(Triggers/Expression)

(Obrigatório se o gatilho Type estiver definido como SCHEDULE)

Especifique a expressão cron que descreve quando você deseja que suas execuções de fluxo de trabalho programadas ocorram.

As expressões Cron no CodeCatalyst usam a seguinte sintaxe de seis campos, em que cada campo é separado por um espaço:

minutos horas dias do mês mês dias da semana ano

Exemplos de expressões cron

Ao especificar expressões cron no CodeCatalyst, siga estas diretrizes:

Para ver mais exemplos de expressões cron e informações sobre curingas, como ?, * e L, consulte a Referência de expressões cron no Guia do usuário do Amazon EventBridge. As expressões cron no EventBridge e no CodeCatalyst funcionam exatamente da mesma maneira.

Para ver exemplos de gatilhos de programação, consulte Exemplos: gatilhos em fluxos de trabalho.

UI correspondente: editor visual/diagrama de fluxo de trabalho/Gatilhos/Programação

Ações

Uma sequência de uma ou mais ações para esse fluxo de trabalho. O CodeCatalyst é compatível com vários tipos de ação, como ações de compilação e teste, que oferecem diferentes tipos de funcionalidade. Cada tipo de ação tem:

Para ter mais informações sobre cada tipo de ação, consulte Tipos de ação. O tópico Tipos de ação tem links para a documentação de cada ação.

Veja a seguir a referência YAML para ações e grupos de ações no arquivo de definição do fluxo de trabalho.

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)

(Obrigatório)

Substitua action-name pelo nome que você deseja dar à ação. Os nomes das ações devem ser exclusivos no fluxo de trabalho e incluir apenas caracteres alfanuméricos, hifens e sublinhados. Para ter mais informações sobre as regras de sintaxe, consulte Diretrizes de sintaxe do YAML.

Para ter mais informações sobre práticas de nomenclatura para ações, inclusive restrições, consulte action-or-gate-name.

UI correspondente: editor visual/action-name/guia Configuração/Nome da ação ou Nome de exibição da ação

action-group-name

(Actions/action-group-name)

(Opcional)

Um grupo de ações contém uma ou mais ações. O agrupamento de ações em grupos ajuda a manter o fluxo de trabalho organizado e também permite configurar dependências entre grupos diferentes.

Substitua action-group-name pelo nome que você deseja dar ao grupo de ações. Os nomes de grupos das ações devem ser exclusivos no fluxo de trabalho e incluir apenas caracteres alfanuméricos, hifens e sublinhados. Para ter mais informações sobre as regras de sintaxe, consulte Diretrizes de sintaxe do YAML.

Para ter mais informações sobre os grupos de ações, consulte Agrupar ações em grupos de ações.

Interface de usuário correspondente: nenhuma