A Amazon não CodeCatalyst está mais aberta a novos clientes. Os clientes atuais podem continuar usando o serviço normalmente. Para obter mais informações, consulte [Como migrar do CodeCatalyst](migration.md).
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á.
# Criação com fluxos de trabalho
Usando [CodeCatalyst fluxos de trabalho](workflow.md), você pode criar aplicativos e outros recursos.
**Topics**
+ [Como faço para criar uma aplicação?](#build-how-to)
+ [Benefícios da ação de criação](#build-benefits)
+ [Alternativas à ação de criação](#build-alternatives)
+ [Adição da ação de criação](build-add-action.md)
+ [Visualização dos resultados de uma ação de criação](build-view-results.md)
+ [Tutorial: Fazer upload de artefatos no Amazon S3](build-deploy.md)
+ [Ações de criação e de teste YAML](build-action-ref.md)
## Como faço para criar uma aplicação?
Para criar um aplicativo ou recurso em CodeCatalyst, primeiro você cria um fluxo de trabalho e, em seguida, especifica uma ação de construção dentro dele.
A *ação de criação* é um componente do fluxo de trabalho que compila seu código-fonte, executa testes de unidade e produz artefatos prontos para implantação.
Você adiciona uma ação de criação ao seu fluxo de trabalho usando o editor visual do CodeCatalyst console ou o editor YAML.
As etapas detalhadas para criar uma aplicação ou um recurso são as seguintes.
**Como criar uma aplicação (tarefas detalhadas)**
1. Em CodeCatalyst, você **adiciona o código-fonte** de um aplicativo que deseja criar. Para obter mais informações, consulte [Armazenando o código-fonte em repositórios para um projeto no CodeCatalyst](source-repositories.md).
1. Em CodeCatalyst, você **cria um fluxo de trabalho**. No fluxo de trabalho, você define como criar, testar e implantar a aplicação. Para obter mais informações, consulte [Conceitos básicos de fluxos de trabalho](workflows-getting-started.md).
1. (Opcional) No fluxo de trabalho, você **adiciona um gatilho** que indica os eventos que farão com que o fluxo de trabalho seja iniciado automaticamente. Para obter mais informações, consulte [Início da execução automática de um fluxo de trabalho usando gatilhos](workflows-add-trigger.md).
1. No fluxo de trabalho, você adiciona uma **ação de criação** que compila e empacota o código-fonte da aplicação ou do recurso. Se desejar, você também poderá fazer com que a ação de criação execute testes de unidade, gere relatórios e implante a aplicação se você não quiser usar uma ação de teste ou de implantação para essas finalidades. Para ter mais informações sobre as ações de teste e de implantação, consulte [Adição da ação de criação](build-add-action.md).
1. (Opcional) No fluxo de trabalho, você **adiciona uma ação de teste** e uma **ação de implantação** para testar e implantar a aplicação ou o recurso. Você pode escolher entre várias ações pré-configuradas para implantar a aplicação em diferentes destinos, como o Amazon ECS. Para ter mais informações, consulte [Teste com fluxos de trabalhoTeste com fluxos de trabalho](test-workflow-actions.md) e [Implantar com fluxos de trabalhoImplantar com fluxos de trabalho](deploy.md).
1. Você **inicia o fluxo de trabalho** manual ou automaticamente por meio de um gatilho. O fluxo de trabalho executa as ações de criação, teste e implantação em sequência para criar, testar e implantar a aplicação e seus recursos no destino. Para obter mais informações, consulte [Iniciar um fluxo de trabalho executado manualmente](workflows-manually-start.md).
## Benefícios da ação de criação
O uso da ação de criação em um fluxo de trabalho fornece os seguintes benefícios:
+ **Totalmente gerenciado**: a ação de criação elimina a necessidade de configurar, aplicar patches e atualizações e gerenciar os próprios servidores de compilação.
+ **Sob demanda**: a ação de criação escala sob demanda, para atender às necessidades da compilação. Você paga somente pela quantidade de minutos de compilação que consumir. Para obter mais informações, consulte [Configuração de imagens de computação e runtime](workflows-working-compute.md).
+ **Pronto para uso — CodeCatalyst inclui imagens Docker de** ambiente de tempo de execução pré-empacotadas que são usadas para executar todas as ações do seu fluxo de trabalho, incluindo ações de construção. Essas imagens vêm pré-configuradas com ferramentas úteis para criar aplicativos como o AWS CLI e o Node.js. Você pode configurar CodeCatalyst para usar uma imagem de compilação fornecida por você a partir de um registro público ou privado. Para obter mais informações, consulte [Especificação de imagens de ambiente de runtime](build-images.md).
## Alternativas à ação de criação
Se você estiver usando uma ação de criação para implantar seu aplicativo, considere usar uma *ação de CodeCatalyst implantação* em vez disso. As ações de implantação realizam behind-the-scenes configurações que, de outra forma, você precisaria escrever manualmente se estivesse usando uma ação de compilação. Para ter mais informações sobre as ações de implantação disponíveis, consulte [Lista de ações de implantação](deploy.md#deploy-concepts-action-supported).
Você também pode usar AWS CodeBuild para criar seus aplicativos. Para obter mais informações, consulte [O que é o CodeBuild?](https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html).
# Adição da ação de criação
Use o procedimento a seguir para adicionar uma ação de criação ao seu CodeCatalyst fluxo de trabalho.
------
#### [ Visual ]
**Para adicionar uma ação de criação usando o editor visual**
1. Abra o CodeCatalyst console em [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. No painel de navegação, escolha **CI/CD** e **Fluxos de trabalho**.
1. Selecione o nome do fluxo de trabalho. É possível filtrar pelo nome do repositório ou da ramificação de origem em que o fluxo de trabalho está definido, ou filtrar pelo nome ou o status do fluxo de trabalho.
1. Escolha **Editar**.
1. Selecione **Visual**.
1. Escolha **Ações**.
1. Em **Ações**, escolha **Criar**.
1. Nas guias **Entradas** e **Configuração**, preencha os campos de acordo com suas necessidades. Para ver uma descrição de cada campo, consulte [Ações de criação e de teste YAML](build-action-ref.md). Essa referência fornece informações detalhadas sobre cada campo (e o valor da propriedade YAML correspondente) conforme elas aparecem nos editores YAML e visual.
1. (Opcional) Selecione **Validar** para validar o código YAML do fluxo de trabalho antes de confirmar.
1. Selecione **Confirmar**, insira uma mensagem de confirmação e escolha **Confirmar** novamente.
------
#### [ YAML ]
**Como adicionar uma ação de criação usando o editor YAML**
1. Abra o CodeCatalyst console em [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. No painel de navegação, escolha **CI/CD** e **Fluxos de trabalho**.
1. Selecione o nome do fluxo de trabalho. É possível filtrar pelo nome do repositório ou da ramificação de origem em que o fluxo de trabalho está definido, ou filtrar pelo nome ou o status do fluxo de trabalho.
1. Escolha **Editar**.
1. Selecione **YAML**.
1. Escolha **Ações**.
1. Em **Ações**, escolha **Criar**.
1. Modifique as propriedades no código YAML de acordo com as suas necessidades. Uma explicação de cada propriedade disponível é fornecida em [Ações de criação e de teste YAML](build-action-ref.md).
1. (Opcional) Selecione **Validar** para validar o código YAML do fluxo de trabalho antes de confirmar.
1. Selecione **Confirmar**, insira uma mensagem de confirmação e escolha **Confirmar** novamente.
------
## Definição de ação de criação
A ação de criação é definida como um conjunto de propriedades YAML dentro do arquivo de definição do fluxo de trabalho. Para ter mais informações sobre essas propriedades, consulte [Ações de criação e de teste YAML](build-action-ref.md) na [Definição do YAML do fluxo de trabalho](workflow-reference.md).
# Visualização dos resultados de uma ação de criação
Use as instruções a seguir para visualizar os resultados de uma ação de criação, incluindo os logs, relatórios e variáveis gerados.
**Para visualizar os resultados de uma ação de criação**
1. No painel de navegação, escolha **CI/CD** e **Fluxos de trabalho**.
1. Selecione o nome do fluxo de trabalho. É possível filtrar pelo nome do repositório ou da ramificação de origem em que o fluxo de trabalho está definido, ou filtrar pelo nome ou o status do fluxo de trabalho.
1. No diagrama do fluxo de trabalho, escolha o nome da ação de criação, por exemplo, **Compilação**.
1. Para ver os logs da execução da criação, selecione **Logs**. Os logs das várias fases de criação são exibidos. Você pode expandir ou recolher os logs conforme necessário.
1. Para visualizar os relatórios de teste produzidos pela ação de criação, selecione **Relatórios** ou, no painel de navegação, selecione **Relatórios**. Para obter mais informações, consulte [Tipos de relatório de qualidade](test-workflow-actions.md#test-reporting).
1. Para ver a configuração usada para a ação de criação, selecione **Configuração**. Para obter mais informações, consulte [Adição da ação de criação](build-add-action.md).
1. Para ver as variáveis usadas pela ação de criação, selecione **Variáveis**. Para obter mais informações, consulte [Uso de variáveis em fluxos de trabalho](workflows-working-with-variables.md).
# Tutorial: Fazer upload de artefatos no Amazon S3
Neste tutorial, você aprende a fazer upload de artefatos em um bucket do Amazon S3 usando um fluxo de trabalho da CodeCatalyst [Amazon](workflows-concepts.md#workflows-concepts-workflows) que inclui algumas ações [de](workflows-concepts.md#workflows-concepts-actions) criação. Essas ações são executadas em série quando o fluxo de trabalho é iniciado. A primeira ação de criação gera dois arquivos, `Hello.txt` e `Goodbye.txt`, e os agrupa em um artefato de criação. A segunda ação de criação carrega o artefato no Amazon S3. Você configurará o fluxo de trabalho para ser executado sempre que enviar uma confirmação para o repositório de origem.
**Topics**
+ [Pré-requisitos](#build-deploy-tut-prereqs)
+ [Etapa 1: criar uma AWS função](#build-deploy-tut-role)
+ [Etapa 2: criar um bucket do Amazon S3](#build-deploy-tut-artifact)
+ [Etapa 3: criar um repositório de origem](#deploy-tut-lambda-cfn-source)
+ [Etapa 4: criar um fluxo de trabalho](#build-deploy-tut-workflow.title)
+ [Etapa 5: verificar os resultados](#build-deploy.s3.verify)
+ [Limpeza](#deploy-tut-lambda-cfn-clean-up)
## Pré-requisitos
Antes de começar, você precisará fazer o seguinte:
+ Você precisa de um CodeCatalyst **espaço** com uma AWS conta conectada. Para obter mais informações, consulte [Criar um espaço](spaces-create.md).
+ Em seu espaço, você precisa de um projeto vazio chamado:
```
codecatalyst-artifact-project
```
Use a opção **Começar do zero** para criar esse projeto.
Para obter mais informações, consulte [Criando um projeto vazio na Amazon CodeCatalyst](projects-create.md#projects-create-empty).
+ Em seu projeto, você precisa de um CodeCatalyst **ambiente** chamado:
```
codecatalyst-artifact-environment
```
Configure esse ambiente da seguinte forma:
+ Escolha qualquer tipo, como **Desenvolvimento**.
+ Conecte sua AWS conta a ela.
+ Para o **Perfil do IAM padrão**, escolha qualquer perfil. Você especificará um perfil diferente posteriormente.
Para obter mais informações, consulte [Implantação em e Contas da AWS VPCs](deploy-environments.md).
## Etapa 1: criar uma AWS função
Nesta etapa, você cria uma função AWS do IAM que posteriormente atribuirá à ação de criação em seu fluxo de trabalho. Essa função concede à ação de CodeCatalyst construção permissão para acessar sua AWS conta e gravar no Amazon S3, onde seu artefato será armazenado. O perfil é chamado de **Perfil de criação**.
**nota**
Se você já tiver um perfil de criação para outro tutorial, também poderá usá-lo para este tutorial. Apenas garanta que ele tenha as permissões e a política de confiança mostradas no procedimento a seguir.
Para obter mais informações sobre as funções do IAM, consulte [Funções do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) no *Guia AWS AWS Identity and Access Management do usuário*.
**Como criar um perfil de criação**
1. Crie uma política para o perfil da seguinte maneira:
1. Faça login em AWS.
1. Abra o console do IAM em [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/).
1. No painel de navegação, selecione **Políticas**.
1. Escolha **Criar política**.
1. Escolha a guia **JSON**.
1. Exclua o código existente.
1. Cole o seguinte código:
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:ListBucket"
],
"Resource": "*"
}
]
}
```
------
**nota**
Na primeira vez em que o perfil for usado para executar ações de fluxo de trabalho, use o caractere curinga na declaração de política de recursos e defina o escopo da política com o nome do recurso depois que ele estiver disponível.
```
"Resource": "*"
```
1. Escolha **Próximo: tags**.
1. Selecione **Próximo: revisar**.
1. Em **Nome**, insira:
```
codecatalyst-s3-build-policy
```
1. Selecione **Criar política**.
Agora você criou uma política de permissões.
1. Crie o perfil de criação, da seguinte forma:
1. No painel de navegação, escolha **Perfis** e **Criar perfil**.
1. Selecione **Política de confiança personalizada**.
1. Exclua a política de confiança personalizada existente.
1. Adicione a política de confiança personalizada a seguir:
1. Escolha **Próximo**.
1. Em **Políticas de permissões**, procure `codecatalyst-s3-build-policy` e marque a caixa de seleção.
1. Escolha **Próximo**.
1. Em **Nome do perfil**, insira:
```
codecatalyst-s3-build-role
```
1. Em **Descrição do perfil**, insira:
```
CodeCatalyst build role
```
1. Selecione **Criar perfil**.
Agora você criou um perfil de criação com uma política de confiança e uma política de permissões.
## Etapa 2: criar um bucket do Amazon S3
Nesta etapa, você cria um bucket do Amazon S3 no qual os artefatos `Hello.txt` e `Goodbye.txt` serão carregados.
**Como criar um bucket do Amazon S3**
1. Abra o console do Amazon S3 em [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/).
1. No painel principal, selecione **Criar bucket**.
1. Em **Nome do bucket**, insira:
```
codecatalyst-artifact-bucket
```
1. Na **região da AWS **, escolha uma região. Este tutorial pressupõe que você tenha escolhido o **Oeste dos EUA (Oregon) us-west-2**. Para ter informações sobre regiões com suporte do Amazon S3, consulte [Endpoints e cotas do Amazon Simple Storage Service](https://docs.aws.amazon.com/general/latest/gr/s3.html) na *Referência geral da AWS*.
1. Selecione **Criar bucket** na parte inferior da página.
1. Copie o nome do bucket que você acabou de criar, por exemplo:
```
codecatalyst-artifact-bucket
```
Agora você criou um bucket chamado **codecatalyst-artifact-bucket** na região Oeste dos EUA (Oregon), us-west-2.
## Etapa 3: criar um repositório de origem
Nesta etapa, você cria um repositório de origem no CodeCatalyst. Esse repositório é usado para armazenar o arquivo de definição do fluxo de trabalho do tutorial.
Para ter mais informações sobre repositórios de origem, consulte [Criar um repositório de origem](source-repositories-create.md).
**Como criar um repositório de origem**
1. Abra o CodeCatalyst console em [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. Navegue até o projeto, `codecatalyst-artifact-project`.
1. No painel de navegação, selecione **Código** e, em seguida, selecione **Repositórios de origem**.
1. Escolha **Adicionar repositório** e selecione **Criar repositório**.
1. Em **Nome do repositório**, insira:
```
codecatalyst-artifact-source-repository
```
1. Escolha **Criar**.
Agora você criou um repositório chamado `codecatalyst-artifact-source-repository`.
## Etapa 4: criar um fluxo de trabalho
Nesta etapa, você cria um fluxo de trabalho que consiste nos seguintes componentes que são executados sequencialmente:
+ Um gatilho – Esse gatilho inicia a execução automática do fluxo de trabalho quando você envia uma alteração ao seu repositório de origem. Para ter mais informações sobre gatilhos, consulte [Início da execução automática de um fluxo de trabalho usando gatilhos](workflows-add-trigger.md).
+ Uma ação de criação chamada `GenerateFiles` — No gatilho, a ação `GenerateFiles` cria dois arquivos, `Hello.txt` e `Goodbye.txt`, os empacota em um artefato de saída chamado `codecatalystArtifact`.
+ Outra ação de criação chamada `Upload` — Ao concluir a ação `GenerateFiles`, a ação `Upload` executa o comando da AWS CLI `aws s3 sync` para carregar os arquivos no `codecatalystArtifact` e no repositório de origem para o bucket do Amazon S3. AWS CLI Ele vem pré-instalado e pré-configurado na plataforma de CodeCatalyst computação, então você não precisa instalá-lo ou configurá-lo.
Para obter mais informações sobre o software pré-empacotado na plataforma de CodeCatalyst computação, consulte. [Especificação de imagens de ambiente de runtime](build-images.md) Para obter mais informações sobre o `aws s3 sync` comando AWS CLI's, consulte [sync](https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html) na *Referência de AWS CLI Comandos*.
Para ter mais informações sobre a ação de criação, consulte [Criação com fluxos de trabalho](build-workflow-actions.md).
**Como criar um fluxo de trabalho**
1. No painel de navegação, escolha **CI/CD** e **Fluxos de trabalho**.
1. Selecione **Criar fluxo de trabalho**.
1. Exclua o código de amostra YAML.
1. Adicione o seguinte código YAML:
**nota**
No código YAML a seguir, você pode omitir a seção `Connections:` se quiser. Se você omitir essa seção, deverá garantir que o perfil especificado no campo **Perfil do IAM padrão** em seu ambiente inclua as permissões e as políticas de confiança descritas em [Etapa 1: criar uma AWS função](#build-deploy-tut-role). Para ter mais informações sobre como configurar um ambiente com um perfil do IAM padrão, consulte [Criar um ambiente](deploy-environments-creating-environment.md).
```
Name: codecatalyst-artifact-workflow
SchemaVersion: 1.0
Triggers:
- Type: Push
Branches:
- main
Actions:
GenerateFiles:
Identifier: aws/build@v1
Configuration:
Steps:
# Create the output files.
- Run: echo "Hello, World!" > "Hello.txt"
- Run: echo "Goodbye!" > "Goodbye.txt"
Outputs:
Artifacts:
- Name: codecatalystArtifact
Files:
- "**/*"
Upload:
Identifier: aws/build@v1
DependsOn:
- GenerateFiles
Environment:
Name: codecatalyst-artifact-environment
Connections:
- Name: codecatalyst-account-connection
Role: codecatalyst-s3-build-role
Inputs:
Artifacts:
- codecatalystArtifact
Configuration:
Steps:
# Upload the output artifact to the S3 bucket.
- Run: aws s3 sync . s3://codecatalyst-artifact-bucket
```
No código acima, substitua:
+ *codecatalyst-artifact-environment*com o nome do ambiente em que você criou[Pré-requisitos](#build-deploy-tut-prereqs).
+ *codecatalyst-account-connection*com o nome da conexão da conta que você criou[Pré-requisitos](#build-deploy-tut-prereqs).
+ *codecatalyst-s3-build-role* pelo nome do perfil de criação criado em [Etapa 1: criar uma AWS função](#build-deploy-tut-role).
+ *codecatalyst-artifact-bucket*com o nome do Amazon S3 em que você criou. [Etapa 2: criar um bucket do Amazon S3](#build-deploy-tut-artifact)
Para ter informações sobre as propriedades nesse arquivo, consulte a [Ações de criação e de teste YAML](build-action-ref.md).
1. (Opcional) Selecione **Validar** para garantir que o código YAML seja válido antes de confirmar.
1. Selecione **Confirmar**.
1. Na caixa de diálogo **Confirmar fluxo de trabalho**, insira o seguinte:
1. Em **Nome do arquivo do fluxo de trabalho**, deixe o padrão, `codecatalyst-artifact-workflow`.
1. Em **Confirmar mensagem**, insira:
```
add initial workflow file
```
1. Em **Repositório**, selecione **codecatalyst-artifact-source-repository**.
1. Em **Nome da ramificação**, selecione **principal**.
1. Selecione **Confirmar**.
Agora você criou um fluxo de trabalho. A execução de um fluxo de trabalho é iniciada automaticamente devido ao gatilho definido na parte superior do fluxo de trabalho. Especificamente, quando você confirmou (e enviou) o arquivo `codecatalyst-artifact-workflow.yaml` ao repositório de origem, o gatilho iniciou a execução do fluxo de trabalho.
**Para visualizar a execução do fluxo de trabalho em andamento**
1. No painel de navegação, escolha **CI/CD** e **Fluxos de trabalho**.
1. Escolha o fluxo de trabalho que você acabou de criar: `codecatalyst-artifact-workflow`.
1. Escolha **GenerateFiles**ver o progresso da primeira ação de construção.
1. Selecione **Carregar** para ver o progresso da segunda ação de criação.
1. Quando a ação **Carregar** terminar, faça o seguinte:
+ Se a execução do fluxo de trabalho for bem-sucedida, vá para o próximo procedimento.
+ Se a execução do fluxo de trabalho falhar, selecione **Logs** para solucionar o problema.
## Etapa 5: verificar os resultados
Depois que o fluxo de trabalho for executado, acesse o serviço Amazon S3 e examine seu *codecatalyst-artifact-bucket* bucket. Agora ele deve incluir os seguintes arquivos e pastas:
```
.
|— .aws/
|— .git/
|Goodbye.txt
|Hello.txt
|REAME.md
```
Os arquivos `Goodbye.txt` e `Hello.txt` foram enviados porque faziam parte do artefato `codecatalystArtifact`. Os arquivos `.aws/`, `.git/` e `README.md` foram enviados porque estavam no repositório de origem.
## Limpeza
Limpe CodeCatalyst e evite AWS ser cobrado por esses serviços.
**Para limpar CodeCatalyst**
1. Abra o CodeCatalyst console em [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. Exclua o repositório de origem `codecatalyst-artifact-source-repository`.
1. Exclua o fluxo de trabalho `codecatalyst-artifact-workflow`.
**Para limpar AWS**
1. Limpe no Amazon S3, da seguinte forma:
1. Abra o console do Amazon S3 em [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/).
1. Exclua os arquivos no bucket `codecatalyst-artifact-bucket`.
1. Exclua o bucket `codecatalyst-artifact-bucket`.
1. Limpe no IAM, da seguinte forma:
1. Abra o console do IAM em [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/).
1. Exclua o `codecatalyst-s3-build-policy`.
1. Exclua o `codecatalyst-s3-build-role`.
# Ações de criação e de teste YAML
Veja a seguir a definição YAML das ações de criação e de teste. Há uma referência para duas ações porque as propriedades YAML de cada uma são muito semelhantes.
Essa definição de ação existe como uma seção dentro de um arquivo de definição de fluxo de trabalho mais amplo. Para obter mais informações sobre esse arquivo, consulte [Definição do YAML do fluxo de trabalho](workflow-reference.md).
Escolha uma propriedade YAML no código a seguir para ver uma descrição dela.
**nota**
A maioria das propriedades YAML a seguir tem elementos de interface de usuário correspondentes no editor visual. Para pesquisar um elemento de interface, use **Ctrl\$1F**. O elemento será listado com a propriedade YAML associada.
```
# The workflow definition starts here.
# See Propriedades de nível superior 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
```
## action-name
(Obrigatório)
Especifique o nome da ação. Todos os nomes de ação devem ser exclusivos no fluxo de trabalho. Os nomes de ação são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (\$1). Não são permitidos espaços. Não é possível usar aspas para habilitar caracteres especiais e espaços nos nomes de ação.
Interface de usuário correspondente: guia Configuração/**Nome da ação**
## Identifier
(*action-name*/**Identifier**)
Identifica a ação. Não altere essa propriedade, a menos que você queira alterar a versão. Para obter mais informações, consulte [Especificação da versão da ação a ser usada](workflows-action-versions.md).
Use `aws/build@v1` para ações de criação.
Use `aws/managed-test@v1` para ações de teste.
UI correspondente: diagrama de fluxo de trabalho/nome da *aws/build@v1\$1aws/managed-test@v1* ação/rótulo
## DependsOn
(*action-name*/**DependsOn**)
(Optional)
Especifique uma ação, um grupo de ação ou um portão que deve ser executado com êxito para que essa ação seja executada.
Para ter mais informações sobre a funcionalidade “Depende de”, consulte [Sequenciar ações](workflows-depends-on.md).
Interface de usuário correspondente: guia Entradas/**Depende de - opcional**
## Compute
(*action-name*/**Compute**)
(Optional)
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 obter mais informações, consulte [Compartilhamento de computação entre ações](compute-sharing.md).
Interface de usuário correspondente: *nenhuma*
## Type
(*action-name*/Compute/**Tipo**)
(Obrigatório se [Compute](#build.computename) for incluído)
O tipo do mecanismo de computação. É possível usar um dos seguintes valores:
+ **EC2** (editor visual) ou `EC2` (editor YAML)
Otimizado para flexibilidade durante as execuções de ação.
+ **Lambda** (editor visual) ou `Lambda` (editor YAML)
Velocidades otimizadas de inicialização da ação.
Para obter informações sobre tipos de dados, consulte [Tipos de computação](workflows-working-compute.md#compute.types).
Interface de usuário correspondente: guia Configuração/**Tipo de computação**
## Fleet
(*action-name*/Compute/**Fleet**)
(Optional)
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](workflows-working-compute.md#compute.on-demand).
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](workflows-working-compute.md#compute.provisioned-fleets).
Se `Fleet` for omitido, o padrão será `Linux.x86-64.Large`.
Interface de usuário correspondente: guia Configuração/**Frota de computação**
## Timeout
(*action-name*/**Timeout**)
(Optional)
Especifique a quantidade de tempo em minutos (editor YAML) ou horas e minutos (editor visual) que a ação pode ser executada antes de CodeCatalyst finalizar a ação. O mínimo é de cinco minutos e o máximo está descrito em [Cotas para fluxos de trabalho em CodeCatalyst](workflows-quotas.md). O tempo limite padrão é igual ao tempo limite máximo.
Interface de usuário correspondente: guia Configuração/**Tempo limite - opcional**
## Environment
(*action-name*/**Environment**)
(Optional)
Especifique o CodeCatalyst ambiente a ser usado com a ação. A ação se conecta à Conta da AWS Amazon VPC opcional especificada no ambiente escolhido. A ação usa a função padrão do IAM especificada no ambiente para se conectar ao e usa a Conta da AWS função do IAM especificada na [conexão da Amazon VPC](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html) para se conectar à Amazon VPC.
**nota**
Se o perfil do IAM padrão não tiver as permissões exigidas pela ação, você poderá configurar a ação para usar um perfil diferente. Para obter mais informações, consulte [Alteração do perfil do IAM de uma ação](deploy-environments-switch-role.md).
Para ter mais informações sobre ambientes, consulte [Implantação em e Contas da AWS VPCs](deploy-environments.md) e [Criar um ambiente](deploy-environments-creating-environment.md).
Interface de usuário correspondente: guia Configuração/**Ambiente**
## Name
(*action-name*/Environment/**Name**)
(Optional)
Especifique o nome de um ambiente existente que deseja associar à ação.
Interface de usuário correspondente: guia Configuração/**Ambiente**
## Connections
(*action-name*/Environment/**Connections**)
(Optional)
Especifique a conexão da conta a ser associada à ação. É possível especificar no máximo uma conexão de conta em `Environment`.
Se você não especificar uma conexão de conta:
+ A ação usa a Conta da AWS conexão e a função padrão do IAM especificadas no ambiente no CodeCatalyst console. Para ter informações sobre como adicionar uma conexão de conta e um perfil do IAM padrão ao ambiente, consulte [Criar um ambiente](deploy-environments-creating-environment.md).
+ O perfil do IAM padrão deve incluir as políticas e as permissões exigidas pela ação. Para determinar quais são essas políticas e permissões, consulte a descrição da propriedade **Perfil** na documentação de definição de YAML da ação.
Para ter mais informações sobre conexões de conta, consulte [Permitindo acesso a AWS recursos com conexão Contas da AWS](ipa-connect-account.md). Para ter informações sobre como adicionar uma conexão de conta a um ambiente, consulte [Criar um ambiente](deploy-environments-creating-environment.md).
UI correspondente: a configuração tab/Environment/What está pronta*my-environment*? **/menu de três pontos/ Mudar função**
## Name
(*action-name*/Environment/Connections/**Name**)
(Obrigatório se [Connections](#build.environment.connections) for incluído)
Especifique o nome da conexão da conta.
UI correspondente: a configuração tab/Environment/What está pronta*my-environment*? **/menu de três pontos/ Mudar função**
## Role
(*action-name*/Environment/Connections/**Role**)
(Obrigatório se [Connections](#build.environment.connections) for incluído)
Especifique o nome do perfil do IAM que essa ação usa para acessar e operar em serviços da AWS , como o Amazon S3 e o Amazon ECR. Esse perfil deve ser adicionado à conexão da Conta da AWS no espaço. Para adicionar um perfil do IAM a uma conexão de conta, consulte [Adicionar perfis do IAM às conexões da conta](ipa-connect-account-addroles.md).
Se você não especificar uma função do IAM, a ação usará a função padrão do IAM listada no [ambiente](deploy-environments.md) no CodeCatalyst console. Se você usar o perfil padrão no ambiente, verifique se ele tem as políticas a seguir.
**nota**
É possível usar o perfil `CodeCatalystWorkflowDevelopmentRole-spaceName` com essa ação. Para obter mais informações sobre esse perfil, consulte [Criar o perfil **CodeCatalystWorkflowDevelopmentRole-*spaceName*** para a conta e o espaço](ipa-iam-roles.md#ipa-iam-roles-service-create). Entenda que o perfil `CodeCatalystWorkflowDevelopmentRole-spaceName` tem permissões de acesso completas, o que pode representar um risco de segurança. Recomendamos que você use esse perfil apenas em tutoriais e em cenários em que a segurança seja menos preocupante.
**Atenção**
Limite as permissões às exigidas pelas ações de criação e de teste. Usar um perfil com permissões mais amplas pode representar um risco de segurança.
UI correspondente: a configuração tab/Environment/What está pronta*my-environment*? **/menu de três pontos/ Mudar função**
## Caching
(*action-name*/**Caching**)
(Optional)
Uma seção na qual você pode especificar um cache para salvar arquivos em disco e restaurá-los desse cache em execuções subsequentes do fluxo de trabalho.
Para ter mais informações sobre armazenamento de arquivos em cache, consulte [Armazenar arquivos em cache entre execuções de fluxo de trabalho](workflows-caching.md).
Interface de usuário correspondente: guia Configuração/**Armazenamento de arquivos em cache - opcional**
## FileCaching
(*action-name*/Caching/**FileCaching**)
(Optional)
Uma seção que especifica a configuração de uma sequência de caches.
**UI correspondente: tab/File Cache de configuração - opcional/Adicionar cache**
## key-name-1
(*action-name*/Caching/FileCaching/***key-name-1***)
(Optional)
Especifique o nome da propriedade de cache principal. Os nomes de propriedade de cache devem ser exclusivos no fluxo de trabalho. Cada ação pode ter até cinco entradas em `FileCaching`.
**UI correspondente: tab/File Cache de configuração - opcional/Adicionar cache/chave**
## Path
(*action-name*/Caching/FileCaching/*key-name-1*/**Path**)
(Optional)
Especifique o caminho associado ao cache.
**UI correspondente: tab/File Cache de configuração - opcional/Adicionar cache/caminho**
## RestoreKeys
(*action-name*/Caching/FileCaching/*key-name-1*/**RestoreKeys**)
(Optional)
Especifique a chave de restauração a ser usada como fallback quando a propriedade do cache principal não puder ser encontrada. Os nomes de chave de restauração devem ser exclusivos no fluxo de trabalho. Cada cache pode ter até cinco entradas em `RestoreKeys`.
**UI correspondente: tab/File Cache de configuração - opcional/Adicionar cache/Restaurar chaves - opcional**
## Inputs
(*action-name*/**Inputs**)
(Optional)
A seção `Inputs` define os dados de que uma ação precisa durante a execução de um fluxo de trabalho.
**nota**
São permitidas no máximo quatro entradas (uma origem e três artefatos) por ação de criação ou de teste. As variáveis não são contadas nesse total.
Se você precisar consultar arquivos que residem em entradas diferentes (digamos, uma origem e um artefato), a entrada de origem será a entrada primária e o artefato será a entrada secundária. As referências a arquivos em entradas secundárias usam um prefixo especial para diferirem das primárias. Para obter detalhes, consulte [Exemplo: referência de arquivos em vários artefatos](workflows-working-artifacts-ex.md#workflows-working-artifacts-ex-ref-file).
Interface de usuário correspondente: guia **Entradas**
## Sources
(*action-name*/Inputs/**Sources**)
(Optional)
Especifique os rótulos que representam os repositórios de origem que serão necessários para a ação. Atualmente, o único rótulo compatível é `WorkflowSource`, que representa o repositório de origem em que o arquivo de definição de fluxo de trabalho está armazenado.
Se você omitir uma origem, deverá especificar pelo menos um artefato de entrada em `action-name/Inputs/Artifacts`.
Para obter mais informações sobre fontes, consulte [Conectar repositórios de origem aos fluxos de trabalho](workflows-sources.md).
Interface de usuário correspondente: *nenhuma*
## Artifacts - input
(*action-name*/Inputs/**Artifacts**)
(Optional)
Especifique artefatos de ações anteriores que você deseja fornecer como entrada para essa ação. Esses artefatos já devem estar definidos como artefatos de saída em ações anteriores.
Se você não especificar nenhum artefato de entrada, deverá especificar pelo menos um repositório de origem em `action-name/Inputs/Sources`.
Para ter mais informações sobre artefatos, inclusive exemplos, consulte [Compartilhar artefatos e arquivos entre ações](workflows-working-artifacts.md).
**nota**
Se a lista suspensa **Artefatos – opcional** não estiver disponível (editor visual) ou se você receber erros ao validar o YAML (editor YAML), talvez seja porque a ação permite apenas uma entrada. Nesse caso, tente remover a entrada de origem.
Interface de usuário correspondente: guia Entradas/**Artefatos - opcional**
## Variables - input
(*action-name*/Inputs/**Variables**)
(Optional)
Especifique uma sequência de name/value pares que defina as variáveis de entrada que você deseja disponibilizar para a ação. Os nomes de variável são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (\$1). Não são permitidos espaços. Não é possível usar aspas para habilitar caracteres especiais e espaços nos nomes de variável.
Para ter mais informações sobre variáveis, inclusive exemplos, consulte [Uso de variáveis em fluxos de trabalho](workflows-working-with-variables.md).
Interface de usuário correspondente: guia Entradas/**Variáveis - opcional**
## Outputs
(*action-name*/**Outputs**)
(Optional)
Define os dados que são gerados pela ação durante a execução de um fluxo de trabalho.
Interface de usuário correspondente: guia **Saídas**
## Artifacts - output
(*action-name*/Outputs/**Artifacts**)
(Optional)
Especifique o nome de um artefato gerado pela ação. Os nomes de artefato devem ser exclusivos em um fluxo de trabalho e estão limitados a caracteres alfanuméricos (a-z, A-Z, 0-9) e sublinhados (\$1). Espaços, hifens (-) e outros caracteres especiais não são permitidos. Não é possível usar aspas para habilitar espaços, hifens e outros caracteres especiais em nomes de artefato de saída.
Para ter mais informações sobre artefatos, inclusive exemplos, consulte [Compartilhar artefatos e arquivos entre ações](workflows-working-artifacts.md).
Interface de usuário correspondente: guia Saídas/**Artefatos**
## Name
(*action-name*/Outputs/Artifacts/**Name**)
(Obrigatório se [Artifacts - output](#build.outputs.artifacts) for incluído)
Especifique o nome de um artefato gerado pela ação. Os nomes de artefato devem ser exclusivos em um fluxo de trabalho e estão limitados a caracteres alfanuméricos (a-z, A-Z, 0-9) e sublinhados (\$1). Espaços, hifens (-) e outros caracteres especiais não são permitidos. Não é possível usar aspas para habilitar espaços, hifens e outros caracteres especiais em nomes de artefato de saída.
Para ter mais informações sobre artefatos, inclusive exemplos, consulte [Compartilhar artefatos e arquivos entre ações](workflows-working-artifacts.md).
**UI correspondente: tab/Artifacts/New Saídas, saída/nome do artefato de construção**
## Files
(*action-name*/Outputs/Artifacts/**Files**)
(Obrigatório se [Artifacts - output](#build.outputs.artifacts) for incluído)
Especifique os arquivos CodeCatalyst incluídos no artefato gerado pela ação. Esses arquivos são gerados pela ação do fluxo de trabalho quando ela é executada e também estão disponíveis no repositório de origem. Os caminhos de arquivo podem residir em um repositório de origem ou em um artefato de uma ação anterior e são relativos ao repositório de origem ou à raiz do artefato. É possível usar padrões glob para especificar caminhos. Exemplos:
+ Para especificar um único arquivo que esteja na raiz do local de compilação ou do local do repositório de origem, use `my-file.jar`.
+ Para especificar um único arquivo em um subdiretório, use `directory/my-file.jar` ou `directory/subdirectory/my-file.jar`.
+ Para especificar todos os arquivos, use `"**/*"`. O padrão glob `**` indica que corresponde a qualquer número de subdiretórios.
+ Para especificar todos os arquivos e diretórios em um diretório chamado `directory`, use `"directory/**/*"`. O padrão glob `**` indica que corresponde a qualquer número de subdiretórios.
+ Para especificar todos os arquivos em um diretório chamado `directory`, mas não em nenhum de seus subdiretórios, use `"directory/*"`.
**nota**
Se o caminho do arquivo incluir um ou mais asteriscos (`*`) ou outro caractere especial, coloque o caminho entre aspas duplas (`""`). Para ter mais informações sobre caracteres especiais, consulte [Diretrizes e convenções de sintaxe](workflow-reference.md#workflow.terms.syntax.conv).
Para ter mais informações sobre artefatos, inclusive exemplos, consulte [Compartilhar artefatos e arquivos entre ações](workflows-working-artifacts.md).
**nota**
Talvez seja necessário adicionar um prefixo ao caminho do arquivo para indicar em qual artefato ou origem encontrá-lo. Para obter mais informações, consulte [Fazer referência a arquivos do repositório de origem](workflows-sources-reference-files.md) e [Referência de arquivos em um artefato](workflows-working-artifacts-refer-files.md).
UI correspondente: tab/Artifacts/New saídas de **saída/arquivos** produzidos pela compilação
## Variables - output
(*action-name*/Outputs/**Variables**)
(Optional)
Especifique as variáveis que você deseja que a ação exporte para que estejam disponíveis para uso em ações subsequentes.
Para ter mais informações sobre variáveis, inclusive exemplos, consulte [Uso de variáveis em fluxos de trabalho](workflows-working-with-variables.md).
Interface de usuário correspondente: guia Saídas/Variáveis/**Adicionar variável**
## variable-name-1
(*action-name*/Outputs/Variables/*variable-name-1*)
(Optional)
Especifique o nome de uma variável a ser exportada pela ação. Essa variável já deve estar definida na seção `Inputs` ou `Steps` da mesma ação.
Para ter mais informações sobre variáveis, inclusive exemplos, consulte [Uso de variáveis em fluxos de trabalho](workflows-working-with-variables.md).
**UI correspondente: tab/Variables/Add Variável de saída/nome**
## AutoDiscoverReports
(*action-name*/Outputs/**AutoDiscoverReports**)
(Optional)
Define a configuração do recurso de descoberta automática.
Quando você ativa a descoberta automática, CodeCatalyst pesquisa todos os dados `Inputs` passados para a ação, bem como todos os arquivos gerados pela própria ação, procurando relatórios de teste, cobertura de código e análise de composição de software (SCA). Para cada relatório encontrado, CodeCatalyst transforma-o em um CodeCatalyst relatório. Um *CodeCatalyst relatório* é um relatório totalmente integrado ao CodeCatalyst serviço e que pode ser visualizado e manipulado por meio do CodeCatalyst console.
**nota**
Por padrão, o recurso de descoberta automática inspeciona todos os arquivos. É possível limitar quais arquivos são inspecionados usando as propriedades [IncludePaths](#build.reports.includepaths) ou [ExcludePaths](#build.reports.excludepaths).
Interface de usuário correspondente: guia Saídas/Relatórios/**Relatórios de descoberta automática**
## Enabled
(*action-name*/Outputs/AutoDiscoverReports/**Enabled**)
(Optional)
Habilite ou desabilite o recurso de descoberta automática.
Os valores válidos são `true` ou `false`.
Se `Enabled` for omitido, o padrão será `true`.
Interface de usuário correspondente: guia Saídas/Relatórios/**Relatórios de descoberta automática**
## ReportNamePrefix
(*action-name*/Outputs/AutoDiscoverReports/**ReportNamePrefix**)
(Obrigatório se [AutoDiscoverReports](#build.outputs.autodiscover) estiver incluído e habilitado)
Especifique um prefixo que seja CodeCatalyst anexado a todos os relatórios encontrados para nomear seus relatórios associados. CodeCatalyst Por exemplo, se você especificar um prefixo de`AutoDiscovered`, e CodeCatalyst descobrir automaticamente dois relatórios de teste, `TestSuiteOne.xml` e`TestSuiteTwo.xml`, os CodeCatalyst relatórios associados serão nomeados e. `AutoDiscoveredTestSuiteOne` `AutoDiscoveredTestSuiteTwo`
Interface de usuário correspondente: guia Saídas/Relatórios/**Nome do prefixo**
## IncludePaths
(*action-name*/Outputs/AutoDiscoverReports/**IncludePaths**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/**IncludePaths**)
(Obrigatório se [AutoDiscoverReports](#build.outputs.autodiscover) estiver incluído e habilitado ou se [Reports](#test.configuration.reports) estiver incluído)
Especifique os arquivos e os caminhos de arquivo CodeCatalyst incluídos na pesquisa de relatórios brutos. Por exemplo, se você especificar`"/test/report/*"`, CodeCatalyst pesquisa toda a [imagem de compilação](build-images.md) usada pela ação procurando o `/test/report/*` diretório. Quando encontra esse diretório CodeCatalyst , procura relatórios nesse diretório.
**nota**
Se o caminho do arquivo incluir um ou mais asteriscos (`*`) ou outros caracteres especiais, coloque o caminho entre aspas duplas (`""`). Para ter mais informações sobre caracteres especiais, consulte [Diretrizes e convenções de sintaxe](workflow-reference.md#workflow.terms.syntax.conv).
Se essa propriedade for omitida, o padrão será `"**/*"`, o que significa que a pesquisa inclui todos os arquivos em todos os caminhos.
**nota**
Em relatórios configurados manualmente, `IncludePaths` deverá ser um padrão global que corresponda a um único arquivo.
Interface de usuário correspondente:
+ **Caminhos de tab/Reports/Auto-discover reports/Include/exclude saída/ Caminhos de inclusão**
+ **Saídas tab/Reports/Manually configuram relatórios/ /incluir/excluir *report-name-1* caminhos/ Incluir caminhos**
## ExcludePaths
(*action-name*/Outputs/AutoDiscoverReports/**ExcludePaths**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/**ExcludePaths**)
(Optional)
Especifique os arquivos e os caminhos de arquivo que são CodeCatalyst excluídos ao pesquisar relatórios brutos. Por exemplo, se você especificar`"/test/my-reports/**/*"`, não CodeCatalyst procurará arquivos no `/test/my-reports/` diretório. Para ignorar todos os arquivos em um diretório, use o padrão de glob `**/*`.
**nota**
Se o caminho do arquivo incluir um ou mais asteriscos (`*`) ou outros caracteres especiais, coloque o caminho entre aspas duplas (`""`). Para ter mais informações sobre caracteres especiais, consulte [Diretrizes e convenções de sintaxe](workflow-reference.md#workflow.terms.syntax.conv).
Interface de usuário correspondente:
+ **Caminhos de tab/Reports/Auto-discover reports/Include/exclude saída/ caminhos de exclusão**
+ **As saídas tab/Reports/Manually configuram relatórios/ /incluir/excluir *report-name-1* caminhos/ Excluir caminhos**
## SuccessCriteria
(*action-name*/Outputs/AutoDiscoverReports/**SuccessCriteria**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/**SuccessCriteria**)
(Optional)
Especifique os critérios de sucesso para os relatórios de teste, cobertura de código, análise de composição de software (SCA) e análise estática (SA).
Para obter mais informações, consulte [Configuração de critérios de sucesso para relatórios](test-config-action.md#test.success-criteria).
Interface de usuário correspondente: guia Saída/Relatórios/**Critérios de sucesso**
## PassRate
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**PassRate**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**PassRate**)
(Optional)
Especifique a porcentagem de testes em um relatório de teste que devem ser aprovados para que o CodeCatalyst relatório associado seja marcado como aprovado. Os valores válidos são números decimais. Por exemplo: `50`, `60.5`. Os critérios de taxa de aprovação são aplicados somente aos relatórios de teste. Para ter mais informações sobre os relatórios de teste, consulte [Relatórios de teste](test-workflow-actions.md#test-reports).
**UI correspondente: tab/Reports/Success critérios de saída/taxa de aprovação**
## LineCoverage
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**LineCoverage**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**LineCoverage**)
(Optional)
Especifique a porcentagem de linhas em um relatório de cobertura de código que devem ser cobertas para que o CodeCatalyst relatório associado seja marcado como aprovado. Os valores válidos são números decimais. Por exemplo: `50`, `60.5`. Os critérios de cobertura de linha são aplicados somente aos relatórios de cobertura de código. Para ter mais informações sobre relatórios de cobertura de código, consulte [Relatórios de cobertura de código](test-workflow-actions.md#test-code-coverage-reports).
**UI correspondente: tab/Reports/Success critérios de saída/cobertura de linha**
## BranchCoverage
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**BranchCoverage**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**BranchCoverage**)
(Optional)
Especifique a porcentagem de filiais em um relatório de cobertura de código que devem ser cobertas para que o CodeCatalyst relatório associado seja marcado como aprovado. Os valores válidos são números decimais. Por exemplo: `50`, `60.5`. Os critérios de cobertura de ramificações são aplicados somente aos relatórios de cobertura de código. Para ter mais informações sobre relatórios de cobertura de código, consulte [Relatórios de cobertura de código](test-workflow-actions.md#test-code-coverage-reports).
**UI correspondente: tab/Reports/Success critérios de saída/cobertura da filial**
## Vulnerabilities
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**Vulnerabilities**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**Vulnerabilities**)
(Optional)
Especifique o número máximo e a gravidade das vulnerabilidades permitidas no relatório SCA para que o CodeCatalyst relatório associado seja marcado como aprovado. Para especificar vulnerabilidades, é necessário especificar:
+ A gravidade mínima das vulnerabilidades que você deseja incluir na contagem. Os valores válidos, do mais grave para o menos grave, são: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` e `INFORMATIONAL`.
Por exemplo, se você escolher `HIGH`, as vulnerabilidades `HIGH` e `CRITICAL` serão contabilizadas.
+ O número máximo de vulnerabilidades da gravidade especificada que você deseja permitir. Exceder esse número faz com que o CodeCatalyst relatório seja marcado como falhado. Os valores válidos são números inteiros.
Os critérios de vulnerabilidade são aplicados somente aos relatórios de SCA. Para ter mais informações sobre os relatórios de SCA, consulte [Relatórios de análise de composição de software](test-workflow-actions.md#test-sca-reports).
Para especificar a gravidade mínima, use a propriedade `Severity`. Para especificar o número máximo de vulnerabilidades, use a propriedade `Number`.
**UI correspondente: tab/Reports/Success critérios de saída/vulnerabilidades**
## StaticAnalysisBug
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**StaticAnalysisBug**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**StaticAnalysisBug**)
(Optional)
Especifique o número máximo e a gravidade dos bugs permitidos no relatório SA para que o CodeCatalyst relatório associado seja marcado como aprovado. Para especificar bugs, é necessário especificar:
+ A gravidade mínima dos bugs que você deseja incluir na contagem. Os valores válidos, do mais grave para o menos grave, são: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` e `INFORMATIONAL`.
Por exemplo, se você escolher `HIGH`, os bugs `HIGH` e `CRITICAL` serão contabilizados.
+ O número máximo de bugs da gravidade especificada que você deseja permitir. Exceder esse número faz com que o CodeCatalyst relatório seja marcado como falhado. Os valores válidos são números inteiros.
Os critérios de bugs são aplicados somente PyLint aos relatórios do ESLint SA. Para ter mais informações sobre os relatórios SA, consulte [Relatórios de análise estática](test-workflow-actions.md#test-static-analysis-reports).
Para especificar a gravidade mínima, use a propriedade `Severity`. Para especificar o número máximo de vulnerabilidades, use a propriedade `Number`.
**UI correspondente: tab/Reports/Success critérios de saída/bugs**
## StaticAnalysisSecurity
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**StaticAnalysisSecurity**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**StaticAnalysisSecurity**)
(Optional)
Especifique o número máximo e a gravidade das vulnerabilidades de segurança permitidas no relatório SA para que o CodeCatalyst relatório associado seja marcado como aprovado. Para especificar vulnerabilidades de segurança, é necessário especificar:
+ A gravidade mínima das vulnerabilidades de segurança que você deseja incluir na contagem. Os valores válidos, do mais grave para o menos grave, são: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` e `INFORMATIONAL`.
Por exemplo, se você escolher `HIGH`, as vulnerabilidades de segurança `HIGH` e `CRITICAL` serão contabilizadas.
+ O número máximo de vulnerabilidades de segurança da gravidade especificada que você deseja permitir. Exceder esse número faz com que o CodeCatalyst relatório seja marcado como falhado. Os valores válidos são números inteiros.
Os critérios de vulnerabilidades de segurança são aplicados somente aos PyLint relatórios do ESLint SA. Para ter mais informações sobre os relatórios SA, consulte [Relatórios de análise estática](test-workflow-actions.md#test-static-analysis-reports).
Para especificar a gravidade mínima, use a propriedade `Severity`. Para especificar o número máximo de vulnerabilidades, use a propriedade `Number`.
**UI correspondente: tab/Reports/Success critérios de saída/vulnerabilidades de segurança**
## StaticAnalysisQuality
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**StaticAnalysisQuality**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**StaticAnalysisQuality**)
(Optional)
Especifique o número máximo e a gravidade dos problemas de qualidade permitidos no relatório SA para que o CodeCatalyst relatório associado seja marcado como aprovado. Para especificar problemas de qualidade, é necessário especificar:
+ A gravidade mínima dos problemas de qualidade que você deseja incluir na contagem. Os valores válidos, do mais grave para o menos grave, são: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` e `INFORMATIONAL`.
Por exemplo, se você escolher `HIGH`, os problemas de qualidade `HIGH` e `CRITICAL` serão contabilizados.
+ O número máximo de problemas de qualidade da gravidade especificada que você deseja permitir. Exceder esse número faz com que o CodeCatalyst relatório seja marcado como falhado. Os valores válidos são números inteiros.
Os critérios de problemas de qualidade são aplicados somente PyLint aos relatórios ESLint da SA. Para ter mais informações sobre os relatórios SA, consulte [Relatórios de análise estática](test-workflow-actions.md#test-static-analysis-reports).
Para especificar a gravidade mínima, use a propriedade `Severity`. Para especificar o número máximo de vulnerabilidades, use a propriedade `Number`.
**UI correspondente: tab/Reports/Success critérios de saída/problemas de qualidade**
## StaticAnalysisFinding
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**StaticAnalysisFinding**)
Ou
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**StaticAnalysisFinding**)
(Optional)
Especifique o número máximo e a severidade das descobertas permitidas no relatório SA para que o CodeCatalyst relatório associado seja marcado como aprovado. Para especificar descobertas, é necessário especificar:
+ A gravidade mínima das descobertas que você deseja incluir na contagem. Os valores válidos, do mais grave para o menos grave, são: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW` e `INFORMATIONAL`.
Por exemplo, se você escolher `HIGH`, as descobertas `HIGH` e `CRITICAL` serão contabilizadas.
+ O número máximo de descobertas da gravidade especificada que você deseja permitir. Exceder esse número faz com que o CodeCatalyst relatório seja marcado como falhado. Os valores válidos são números inteiros.
As descobertas são aplicadas somente aos relatórios de SARIF SA. Para ter mais informações sobre os relatórios SA, consulte [Relatórios de análise estática](test-workflow-actions.md#test-static-analysis-reports).
Para especificar a gravidade mínima, use a propriedade `Severity`. Para especificar o número máximo de vulnerabilidades, use a propriedade `Number`.
**UI correspondente: tab/Reports/Success critérios de saída/descobertas**
## Reports
(*action-name*/Outputs/**Reports** )
(Optional)
Uma seção que especifica a configuração dos relatórios de teste.
Interface de usuário correspondente: guia Saídas/**Relatórios**
## report-name-1
(nome do *action-name* /Outputs/Reports/ **relatório-1)**
(Obrigatório se [Reports](#test.configuration.reports) for incluído)
O nome que você deseja dar ao CodeCatalyst relatório que será gerado a partir de seus relatórios brutos.
**UI correspondente: saídas tab/Reports/Manually configuram relatórios/nome do relatório**
## Format
(*action-name*/Outputs/Reports/*report-name-1*/**Format**)
(Obrigatório se [Reports](#test.configuration.reports) for incluído)
Especifique o formato de arquivo utilizado para os relatórios. Veja a seguir os valores possíveis.
+ Para relatórios de teste:
+ Para Cucumber JSON, especifique **Cucumber** (editor visual) ou `CUCUMBERJSON` (editor YAML).
+ Para JUnit XML, especifique **JUnit**(editor visual) ou `JUNITXML` (editor YAML).
+ Para NUnit XML, especifique **NUnit**(editor visual) ou `NUNITXML` (editor YAML).
+ Para NUnit 3 XML, especifique **NUnit3**(editor visual) ou `NUNIT3XML` (editor YAML).
+ Para Visual Studio TRX, especifique **Visual Studio TRX** (editor visual) ou `VISUALSTUDIOTRX` (editor YAML).
+ Para TestNG XML, especifique **TestNG** (editor visual) ou `TESTNGXML` (editor YAML).
+ Para relatórios de cobertura de código:
+ Para Clover XML, especifique **Clover** (editor visual) ou `CLOVERXML` (editor YAML).
+ Para Cobertura XML, especifique **Cobertura** (editor visual) ou `COBERTURAXML` (editor YAML).
+ Para JaCoCo XML, especifique **JaCoCo**(editor visual) ou `JACOCOXML` (editor YAML).
+ Para SimpleCov JSON gerado por [simplecov, não [simplecov-json](https://github.com/vicentllongo/simplecov-json)](https://github.com/simplecov-ruby/simplecov), especifique Simplecov (editor visual) ou (**editor YAML**). `SIMPLECOV`
+ Para relatórios de análise de composição de software (SCA):
+ Para SARIF, especifique **SARIF** (editor visual) ou `SARIFSCA` (editor YAML).
**UI correspondente: tab/Reports/Manually configure reports/Add/configure relatórios de saídas/*report-name-1*/**Tipo de relatório e formato do relatório****
## Configuration
(*action-name*/**Configuration**)
(Obrigatório) Uma seção na qual você pode definir as propriedades de configuração da ação.
Interface de usuário correspondente: guia **Configuração**
## Container
(*action-name*/Configuration/**Container**)
(Optional)
Especifique a imagem do Docker, ou *contêiner*, que a ação usa para concluir o processamento. Você pode especificar uma das [imagens ativas](build-images.md#build-curated-images) que vêm com CodeCatalyst ela ou usar sua própria imagem. Se você optar por usar a própria imagem, ela poderá residir no Amazon ECR, no Docker Hub ou em outro registro. Se você não especificar uma imagem do Docker, a ação usará uma das imagens ativas para processamento. Para ter informações sobre qual imagem ativa é usada por padrão, consulte [Imagens ativas](build-images.md#build-curated-images).
Para ter mais informações sobre como especificar a própria imagem do Docker, consulte [Atribuir uma imagem do Docker de um ambiente de runtime personalizada a uma ação](build-images.md#build-images-specify).
Interface de usuário correspondente: **Imagem do Docker do runtime - opcional**
## Registry
(*action-name*/Configuration/Container/**Registry**)
(Obrigatório se `Container` for incluído)
Especifique o registro em que a imagem está armazenada. Os valores válidos são:
+ `CODECATALYST` (editor YAML)
A imagem é armazenada no CodeCatalyst registro.
+ **Docker Hub** (editor visual) ou `DockerHub` (editor YAML)
A imagem é armazenada no registro de imagens do Docker Hub.
+ **Outro registro** (editor visual) ou `Other` (editor YAML)
A imagem é armazenada em um registro de imagem personalizado. Qualquer registro disponível publicamente pode ser usado.
+ **Amazon Elastic Container Registry** (editor visual) ou `ECR` (editor YAML)
A imagem é armazenada em um repositório de imagens do Amazon Elastic Container Registry. Para usar uma imagem em um repositório do Amazon ECR, essa ação precisa acessar o Amazon ECR. Para habilitar esse acesso, é necessário criar um [perfil do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) que inclua as permissões e a política de confiança personalizada a seguir. (Se desejar, você poderá modificar um perfil existente para incluir as permissões e a política.)
O perfil do IAM deve incluir as seguintes permissões na política:
+ `ecr:BatchCheckLayerAvailability`
+ `ecr:BatchGetImage`
+ `ecr:GetAuthorizationToken`
+ `ecr:GetDownloadUrlForLayer`
O perfil do IAM deve incluir a seguinte política de confiança personalizada:
Para ter mais informações sobre como criar perfis do IAM, consulte [Criar um perfil usando políticas de confiança personalizadas (console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-custom.html) no *Guia do usuário do IAM*.
Depois que você criar o perfil, deverá atribuí-lo à ação por meio de um ambiente. Para obter mais informações, consulte [Associação de um ambiente a uma ação](deploy-environments-add-app-to-environment.md).
Interface de usuário correspondente: opções **Amazon Elastic Container Registry**, **Docker Hub** e **Outro registro**
## Image
(*action-name*/Configuration/Container/**Image**)
(Obrigatório se `Container` for incluído)
Especifique um dos seguintes:
+ Se você estiver usando um registro `CODECATALYST`, defina a imagem como uma das seguintes [imagens ativas](build-images.md#build-curated-images):
+ `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 você estiver usando um registro do Docker Hub, defina a imagem como o nome da imagem do Docker Hub e a tag opcional.
Exemplo: `postgres:latest`
+ Se estiver usando um registro do Amazon ECR, defina a imagem como o URI do registro do Amazon ECR.
Exemplo: `111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo`
+ Se estiver usando um registro personalizado, defina a imagem como o valor esperado pelo registro personalizado.
Interface de usuário correspondente: **imagem do Docker do ambiente de runtime** (se o registro for `CODECATALYST`), **imagem do Docker Hub** (se o registro for **Docker Hub**), **URL da imagem do ECR** (se o registro for **Amazon Elastic Container Registry**) e **URL da imagem** (se o registro for **Outro registro**).
## Steps
(*action-name*/Configuration/**Steps**)
(Obrigatório)
Especifique os comandos do shell que você deseja executar durante a ação para instalar, configurar e executar as ferramentas de compilação.
Confira um exemplo de como criar um projeto npm:
```
Steps:
- Run: npm install
- Run: npm run build
```
Veja a seguir um exemplo de como especificar caminhos de arquivo:
```
Steps:
- Run: cd $ACTION_BUILD_SOURCE_PATH_WorkflowSource/app && cat file2.txt
- Run: cd $ACTION_BUILD_SOURCE_PATH_MyBuildArtifact/build-output/ && cat file.txt
```
Para ter mais informações sobre como especificar caminhos de arquivo, consulte [Fazer referência a arquivos do repositório de origem](workflows-sources-reference-files.md) e [Referência de arquivos em um artefato](workflows-working-artifacts-refer-files.md).
Interface de usuário correspondente: guia Configuração/**Comandos de shell**
## Packages
(*action-name*/Configuration/**Packages**)
(Optional)
Uma seção na qual você pode especificar um repositório de pacotes que a ação usa para resolver dependências. Os pacotes permitem que você armazene e compartilhe com segurança pacotes de software usados para desenvolvimento de aplicações.
Para ter mais informações sobre pacotes, consulte [Publique e compartilhe pacotes de software no CodeCatalyst](packages.md).
Interface de usuário correspondente: guia Configuração/**Pacotes**
## NpmConfiguration
(*action-name*/Configuration/Packages/**NpmConfiguration**)
(Obrigatório se [Packages](#build.configuration.packages) for incluído)
Uma seção que define a configuração para o formato do pacote npm. Essa configuração é usada por uma ação durante a execução de um fluxo de trabalho.
Para ter mais informações sobre a configuração do pacote npm, consulte [Uso de npm](packages-npm.md).
**UI correspondente: configuração de tab/Packages/Add configuração/npm**
## PackageRegistries
(*action-name*/Configuration/Packages/NpmConfiguration/**PackageRegistries**)
(Obrigatório se [Packages](#build.configuration.packages) for incluído)
Uma seção na qual você pode definir as propriedades de configuração de uma sequência de repositórios de pacotes.
UI correspondente: tab/Packages/Add configuration/npm Configuração/ **Adicionar repositório de pacotes**
## PackagesRepository
(*action-name*/Configuration/Packages/NpmConfiguration/PackageRegistries/**PackagesRepository**)
(Obrigatório se [Packages](#build.configuration.packages) for incluído)
Especifique o nome do *repositório de CodeCatalyst pacotes* que você deseja que a ação use.
Se você especificar vários repositórios padrão, o último repositório terá prioridade.
Para ter mais informações sobre repositórios de pacote, consulte [Repositórios de pacotes](packages-concepts.md#packages-concepts-repository).
**UI correspondente: repositório de tab/Packages/Add configuration/npm/Add pacotes de configuração/repositório de pacotes**
## Scopes
(*action-name*/Configuration/Packages/NpmConfiguration/PackageRegistries/**Scopes**)
(Optional)
Especifique uma sequência de *escopos* que você deseja definir no registro do pacote. Na definição de escopos, o repositório de pacotes especificado é configurado como o registro para todos os escopos listados. Se um pacote com o escopo for solicitado por meio do cliente npm, ele usará esse repositório em vez do padrão. Cada nome de escopo deve ter o prefixo “@”.
Se você incluir escopos substitutos, o último repositório terá prioridade.
Se `Scopes` for omitido, o repositório de pacotes especificado será configurado como o registro padrão para todos os pacotes usados pela ação.
Para ter mais informações sobre escopos, consulte [Namespaces de pacote](packages-concepts.md#packages-concepts-package-namespaces) e [Pacotes com escopo definido](https://docs.npmjs.com/cli/v10/using-npm/scope).
**UI correspondente: tab/Packages/Add configuration/npm/Add repositório/escopos do pacote de configuração - opcional**
## ExportAuthorizationToken
(*action-name*/Configuration/Packages/**ExportAuthorizationToken**)
(Optional)
Habilite ou desabilite o recurso de token de autorização de exportação. Se habilitados, os tokens de autorização exportados podem ser usados para configurar manualmente um gerenciador de pacotes para se autenticar com repositórios de CodeCatalyst pacotes. É possível usar o token como uma variável de ambiente que pode ser referida nas ações.
Os valores válidos são `true` ou `false`.
Se `ExportAuthorizationToken` for omitido, o padrão será `false`.
Para ter mais informações sobre o token de autorização de exportação, consulte [Usar tokens de autorização em ações de fluxo de trabalho](workflows-package-export-token.md).
Interface de usuário correspondente: guia Configuração/Pacotes/**Token de autorização de exportação**