As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

YAMLDefinição de fluxo de trabalho

A seguir está a documentação de referência para o arquivo de definição do fluxo de trabalho.

Um arquivo de definição de fluxo de trabalho é um YAML arquivo que descreve seu fluxo de trabalho. Por padrão, o arquivo é armazenado em uma ~/.codecatalyst/workflows/ pasta na raiz do seu 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 do fluxo de trabalho, você pode usar um editor como o vim ou usar o editor visual ou YAML editor do CodeCatalyst console. Para obter mais informações, consulte Usando o visual e os YAML editores do CodeCatalyst console.

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

Veja a seguir um exemplo de um arquivo simples de definição de fluxo de trabalho. Inclui algumas propriedades de nível superior, uma Triggers seção e uma Actions seção com duas ações: Build e. Test Para obter 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.

YAMLdiretrizes de sintaxe

O arquivo de definição do fluxo de trabalho é gravado YAML e segue a especificação YAML 1.1, portanto, tudo o que é permitido nessa especificação também é permitido no fluxo de trabalhoYAML. Se você é novatoYAML, aqui estão algumas diretrizes rápidas para garantir que você esteja fornecendo um YAML código 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

A seguir está a documentação de referência para as propriedades de nível superior no 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 registros. O nome do fluxo de trabalho e o nome do arquivo de definição do fluxo de trabalho podem coincidir ou você pode nomeá-los de forma diferente. Os nomes dos fluxos de trabalho não precisam ser exclusivos. Os nomes dos fluxos de trabalho são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hífens (-) e sublinhados (_). Não são permitidos espaços. Você não pode usar aspas para ativar caracteres especiais e espaços nos nomes dos fluxos 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.

UI correspondente: nenhuma

RunMode

(Optional)

Como CodeCatalyst lida com várias execuções. Você pode usar um dos seguintes valores:

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

Para obter mais informações, consulte Configurando o comportamento de enfileiramento das execuções.

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

Compute

(Optional)

O mecanismo de computação usado para executar suas ações de fluxo de trabalho. Você pode especificar a computação no nível do fluxo de trabalho ou no nível da ação, mas não em ambos. Quando especificada no nível do fluxo de trabalho, a configuração computacional se aplica a todas as ações definidas no fluxo de trabalho. No nível do fluxo de trabalho, você também pode executar várias ações na mesma instância. Para obter mais informações, consulte Compartilhamento de computação entre ações.

Para obter mais informações sobre computação, consulteConfigurando imagens de computação e tempo de execução.

UI correspondente: nenhuma

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

Type

(Compute/Type)

(Obrigatório se Compute estiver configurado)

O tipo de mecanismo de computação. Você pode 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)

(Optional)

Especifique a máquina ou frota que executará seu fluxo de trabalho ou 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 frotas sob demanda:Linux.x86-64.Large,. Linux.x86-64.XLarge Para obter mais informações sobre frotas sob demanda, consulte. Propriedades de frota sob demanda

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

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

Para obter 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)

(Optional)

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 tempo de execução). Você pode usar um dos seguintes valores:

Para obter mais informações sobre compartilhamento de computação, consulteCompartilhamento de computação entre ações.

UI correspondente: nenhuma

Triggers

(Optional)

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

Para obter mais informações sobre gatilhos, consulte Iniciando um fluxo de trabalho executado automaticamente usando gatilhos.

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

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)

(Obrigatório se Triggers estiver configurado)

Especifique o tipo de gatilho. Você pode usar um dos seguintes valores:

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

UI correspondente: editor visual/diagrama de fluxo de trabalho/acionadores/tipo de gatilho

Events

(Triggers/Events)

(Obrigatório se o gatilho Type estiver definido comoPULLREQUEST)

Especifique o tipo de eventos de pull request que iniciarão a execução de um fluxo de trabalho. A seguir estão os valores válidos:

Você pode especificar vários eventos no mesmo gatilho de pull request.

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

UI correspondente: editor visual/diagrama de fluxo de trabalho/acionadores/eventos para pull request

Branches

(Triggers/Branches)

(Optional)

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

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

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

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

UI correspondente: editor visual/diagrama de fluxo de trabalho/acionadores/ramificações

FilesChanged

(Triggers/FilesChanged)

(Opcional se o gatilho Type estiver definido comoPUSH, ouPULLREQUEST. Não é suportado se o gatilho Type estiver definido comoSCHEDULE.)

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 combinar nomes ou caminhos de arquivos.

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

UI correspondente: editor visual/diagrama de fluxo de trabalho/acionadores/arquivos alterados

Expression

(Triggers/Expression)

(Obrigatório se o gatilho Type estiver definido comoSCHEDULE)

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

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

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

Exemplos de expressões cron

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

Para obter 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 da Amazon EventBridge . As expressões Cron CodeCatalyst funcionam exatamente da mesma maneira. EventBridge

Para obter exemplos de acionadores de agendamento, consulte. Exemplos: acionadores em fluxos de trabalho

UI correspondente: editor visual/diagrama de fluxo de trabalho/acionadores/agenda

Ações

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

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

A seguir está a YAML referência 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)

Substituir action-name com um nome que você deseja dar à ação. Os nomes das ações devem ser exclusivos no fluxo de trabalho e devem incluir somente caracteres alfanuméricos, hífens e sublinhados. Para obter mais informações sobre regras de sintaxe, consulteYAMLdiretrizes de sintaxe.

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

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

action-group-name

(Actions/action-group-name)

(Optional)

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

Substituir action-group-name com um nome que você deseja dar ao grupo de ação. Os nomes dos grupos de ação devem ser exclusivos no fluxo de trabalho e devem incluir somente caracteres alfanuméricos, hífens e sublinhados. Para obter mais informações sobre regras de sintaxe, consulteYAMLdiretrizes de sintaxe.

Para obter mais informações sobre grupos de ação, consulteAgrupando ações em grupos de ação.

UI correspondente: nenhuma