Crie e teste a definição YAML da ação

Veja a seguir a definição YAML das ações de criação e teste. Há uma referência para duas ações porque suas propriedades YAML 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 de fluxo de trabalho YAML.

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 do usuário, use Ctrl+F. O elemento será listado com sua 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

nome da ação

(Obrigatório)

Especifique o nome da ação. Todos os nomes das ações devem ser exclusivos no fluxo de trabalho. Os nomes das ações 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 das ações.

UI correspondente: guia de configuração/nome da ação

Identifier

(nome da ação/) Identifier

Identifica a ação. Não altere essa propriedade, a menos que você queira alterar a versão. Para ter mais informações, consulte Especificar a versão principal, secundária ou de patch de uma ação.

Use aws/build@v1 para criar ações.

Use aws/managed-test@v1 para ações de teste.

UI correspondente: diagrama de fluxo de trabalho/nome da ação/ aws/build @v1 |aws/managed-test @v1 label

DependsOn

(nome da ação/) DependsOn

(Optional)

Especifique uma ação, grupo de ação ou porta que deve ser executada com êxito para que essa ação seja executada.

Para obter mais informações sobre a funcionalidade “depende de”, consulte. Configurando ações para depender de outras ações

UI correspondente: guia Entradas/Depende de - opcional

Compute

(nome da açã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 ter mais informações, consulte Compartilhamento de computação entre ações.

UI correspondente: nenhuma

Type

(tipo de nome da ação/Compute/)

(Obrigatório se Compute estiver incluído)

O tipo de mecanismo de computação. Você pode usar um dos seguintes valores:

EC2 (editor visual) ou EC2 (editor YAML)

Otimizado para flexibilidade durante as corridas 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.

UI correspondente: guia de configuração/tipo de computação

Fleet

(nome da ação) /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

UI correspondente: guia de configuração/frota de computação

Timeout

(nome da ação/) 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 5 minutos e o máximo está descrito emCotas para fluxos de trabalho. O tempo limite padrão é igual ao tempo limite máximo.

UI correspondente: guia de configuração/tempo limite - opcional

Environment

(nome da ação/) 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 para se conectar à Amazon VPC.

nota

Se a função padrão do IAM não tiver as permissões exigidas pela ação, você poderá configurar a ação para usar uma função diferente. Para ter mais informações, consulte Atribuição de uma função diferente do IAM a uma ação.

Para obter mais informações sobre ambientes, consulte Implantação em Contas da AWS e VPCs com ambientes CodeCatalyst Criar um ambiente e.

UI correspondente: guia de configuração/ambiente

Name

(nome da ação) /Environment/ Name

(Optional)

Especifique o nome de um ambiente existente que você deseja associar à ação.

UI correspondente: guia de configuração/ambiente

Connections

(nome da ação) /Environment/ Connections

(Optional)

Especifique a conexão da conta a ser associada à ação. Você pode especificar no máximo uma conexão de conta emEnvironment.

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 obter informações sobre como adicionar uma conexão de conta e uma função padrão do IAM ao ambiente, consulteCriar um ambiente.
A função padrão do IAM deve incluir as políticas e permissões exigidas pela ação. Para determinar quais são essas políticas e permissões, consulte a descrição da propriedade Role na documentação de definição de YAML da ação.

Para obter mais informações sobre conexões de conta, consultePermitindo acesso a AWS recursos com conexão Contas da AWS. Para obter informações sobre como adicionar uma conexão de conta a um ambiente, consulteCriar um ambiente.

UI correspondente: guia de configuração/ambiente/O que há no meu ambiente? /menu de três pontos/ Mudar função

Name

(nome da ação) /Environment/Connections/ Name

(Obrigatório se Connections estiver incluído)

Especifique o nome da conexão da conta.

UI correspondente: guia de configuração/ambiente/O que há no meu ambiente? /menu de três pontos/ Mudar função

Role

(nome da ação) /Environment/Connections/ Role

(Obrigatório se Connections estiver incluído)

Especifique o nome da função do IAM que essa ação usa para acessar e operar em AWS serviços como Amazon S3 e Amazon ECR. Certifique-se de que essa função seja adicionada à sua Conta da AWS conexão em seu espaço. Para adicionar uma função do IAM a uma conexão de conta, consulteAdicionar funções do IAM às conexões da conta.

Se você não especificar uma função do IAM, a ação usará a função padrão do IAM listada no ambiente no CodeCatalyst console. Se você usar a função padrão no ambiente, verifique se ela tem as seguintes políticas.

nota

Você pode usar a CodeCatalystWorkflowDevelopmentRole-spaceName função com essa ação. Para obter mais informações sobre essa função, consulte Criando a CodeCatalystWorkflowDevelopmentRole-spaceNamefunção para sua conta e espaço. Entenda que a CodeCatalystWorkflowDevelopmentRole-spaceName função tem permissões de acesso completas, o que pode representar um risco de segurança. Recomendamos que você use essa função somente em tutoriais e 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 teste. Usar uma função com permissões mais amplas pode representar um risco de segurança.

UI correspondente: guia de configuração/ambiente/O que há no meu ambiente? /menu de três pontos/ Mudar função

Caching

(nome da ação/) 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 obter mais informações sobre o armazenamento em cache de arquivos, consulteArmazenando arquivos em cache entre execuções de fluxo de trabalho.

UI correspondente: guia de configuração/cache de arquivos - opcional

FileCaching

(nome da ação) /Caching/ FileCaching

(Optional)

Uma seção que especifica a configuração de uma sequência de caches.

UI correspondente: guia de configuração/Cache de arquivos - opcional/Adicionar cache

nome-chave-1

(nome da ação nome-chave 1/Caching/FileCaching/)

(Optional)

Especifique o nome da sua propriedade de cache principal. Os nomes das propriedades de cache devem ser exclusivos em seu fluxo de trabalho. Cada ação pode ter até cinco entradasFileCaching.

UI correspondente: guia de configuração/Cache de arquivos - opcional/Adicionar cache/chave

Path

(nome da ação /Caching/FileCaching/ nome-chave 1/) Path

(Optional)

Especifique o caminho associado para seu cache.

UI correspondente: guia de configuração/Cache de arquivos - opcional/Adicionar cache/caminho

RestoreKeys

(nome da ação /Caching/FileCaching/ nome-chave 1/) RestoreKeys

(Optional)

Especifique a chave de restauração a ser usada como alternativa quando a propriedade primária do cache não puder ser encontrada. Os nomes das chaves de restauração devem ser exclusivos em seu fluxo de trabalho. Cada cache pode ter até cinco entradasRestoreKeys.

UI correspondente: guia Configuração/Cache de arquivos - opcional/Adicionar cache/Restaurar chaves - opcional

Inputs

(nome da ação/) Inputs

(Optional)

A Inputs seção define os dados que uma ação precisa durante a execução de um fluxo de trabalho.

nota

São permitidas no máximo quatro entradas (uma fonte e três artefatos) por ação de construção ou ação de teste. As variáveis não contam para esse total.

Se você precisar se referir a arquivos que residem em entradas diferentes (digamos, uma fonte e um artefato), a entrada de origem é a entrada primária e o artefato é a entrada secundária. As referências a arquivos em entradas secundárias usam um prefixo especial para diferenciá-las das primárias. Para obter detalhes, consulte Exemplo: referenciando arquivos em vários artefatos.

UI correspondente: guia Entradas

Sources

(nome da ação) /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 seu arquivo de definição de fluxo de trabalho está armazenado.

Se você omitir uma fonte, deverá especificar pelo menos um artefato de entrada abaixo. action-name/Inputs/Artifacts

Para obter mais informações sobre fontes, consulte Conectando um fluxo de trabalho a um repositório de origem.

UI correspondente: nenhuma

Artifacts - input

(nome da ação) /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 obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de dados entre ações em um fluxo de trabalho usando artefatos.

nota

Se a lista suspensa Artefacts - opcional não estiver disponível (editor visual) ou se você receber erros ao validar seu YAML (editor YAML), talvez seja porque a ação suporta apenas uma entrada. Nesse caso, tente remover a entrada da fonte.

UI correspondente: guia Entradas/Artefatos - opcional

Variables - input

(nome da ação) /Inputs/ Variables

(Optional)

Especifique uma sequência de pares de nome/valor que definam as variáveis de entrada que você deseja disponibilizar para a ação. Os nomes das variáveis 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 em nomes de variáveis.

Para obter mais informações sobre variáveis, incluindo exemplos, consulteConfigurando e usando variáveis em um fluxo de trabalho.

UI correspondente: guia de entradas/variáveis - opcional

Outputs

(nome da ação/) Outputs

(Optional)

Define os dados que são gerados pela ação durante a execução de um fluxo de trabalho.

UI correspondente: guia Saídas

Artifacts - output

(nome da ação) /Outputs/ Artifacts

(Optional)

Especifique o nome de um artefato gerado pela ação. Os nomes dos artefatos devem ser exclusivos em um fluxo de trabalho e estão limitados a caracteres alfanuméricos (a-z, A-Z, 0-9) e sublinhados (_). Espaços, hífens (-) e outros caracteres especiais não são permitidos. Você não pode usar aspas para ativar espaços, hífens e outros caracteres especiais nos nomes dos artefatos de saída.

Para obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de dados entre ações em um fluxo de trabalho usando artefatos.

UI correspondente: guia Saídas/Artefatos

Name

(nome da ação) /Outputs/Artifacts/ Name

(Obrigatório se Artifacts - output estiver incluído)

Para obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de dados entre ações em um fluxo de trabalho usando artefatos.

UI correspondente: guia Saídas/Artefatos/Nova saída/Nome do artefato de construção

Files

(nome da ação) /Outputs/Artifacts/ Files

(Obrigatório se Artifacts - output estiver incluído)

Especifique os arquivos CodeCatalyst incluídos no artefato que é 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 seu 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. Você pode usar padrões globais 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 obter mais informações sobre caracteres especiais, consulteDiretrizes e convenções de sintaxe.

Para obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de dados entre ações em um fluxo de trabalho usando artefatos.

nota

Talvez seja necessário adicionar um prefixo ao caminho do arquivo para indicar em qual artefato ou fonte encontrá-lo. Para obter mais informações, consulte Fazendo referência a arquivos em um repositório de origem e Fazendo referência a arquivos em um artefato.

UI correspondente: guia Saídas/Artefatos/Nova saída/Arquivos produzidos pela compilação

Variables - output

(nome da ação) /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 obter mais informações sobre variáveis, incluindo exemplos, consulteConfigurando e usando variáveis em um fluxo de trabalho.

UI correspondente: guia Saídas/Variáveis/Adicionar variável

nome da variável-1

(nome da ação nome da variável-1/Outputs/Variables/)

(Optional)

Especifique o nome de uma variável que você deseja que a ação exporte. Essa variável já deve estar definida na Steps seção Inputs ou da mesma ação.

Para obter mais informações sobre variáveis, incluindo exemplos, consulteConfigurando e usando variáveis em um fluxo de trabalho.

UI correspondente: guia de saídas/variáveis/Adicionar variável/nome

AutoDiscoverReports

(nome da ação) /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. Você pode limitar quais arquivos são inspecionados usando as ExcludePaths propriedades IncludePaths ou.

UI correspondente: guia Saídas/relatórios/relatórios de descoberta automática

Enabled

(nome da ação) /Outputs/AutoDiscoverReports/ Enabled

(Optional)

Ative ou desative o recurso de descoberta automática.

Os valores válidos são true ou false.

Se Enabled for omitido, o padrão será. true

UI correspondente: guia Saídas/relatórios/relatórios de descoberta automática

ReportNamePrefix

(nome da ação) /Outputs/AutoDiscoverReports/ ReportNamePrefix

(Obrigatório se AutoDiscoverReports estiver incluído e ativado)

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 deAutoDiscovered, e CodeCatalyst descobrir automaticamente dois relatórios de teste, TestSuiteOne.xml eTestSuiteTwo.xml, os CodeCatalyst relatórios associados serão nomeados e. AutoDiscoveredTestSuiteOne AutoDiscoveredTestSuiteTwo

UI correspondente: guia de saídas/relatórios/nome do prefixo

IncludePaths

(nome da ação) /Outputs/AutoDiscoverReports/ IncludePaths

(nome da ação nome do /Outputs/Reports/ relatório-1/) IncludePaths

(Obrigatório se AutoDiscoverReports estiver incluído e ativado, ou se 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 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 obter mais informações sobre caracteres especiais, consulteDiretrizes e convenções de sintaxe.

Se essa propriedade for omitida, o padrão será, o que significa que a pesquisa inclui todos os arquivos em todos os caminhos. "**/*"

nota

Para relatórios configurados manualmente, IncludePaths deve ser um padrão global que corresponda a um único arquivo.

UI correspondente:

Guia de saídas/Relatórios/Descoberta automática de relatórios/Incluir/Excluir caminhos/Incluir caminhos
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1 /Incluir/Excluir caminhos/ Incluir caminhos

ExcludePaths

(nome da ação) /Outputs/AutoDiscoverReports/ ExcludePaths

(nome da ação nome do /Outputs/Reports/ relatório-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 **/* glob.

nota

UI correspondente:

Guia de saídas/Relatórios/Descoberta automática de relatórios/Incluir/Excluir caminhos/Excluir caminhos
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1 /Incluir/Excluir caminhos/ Excluir caminhos

SuccessCriteria

(nome da ação) /Outputs/AutoDiscoverReports/ SuccessCriteria

(nome da ação nome do /Outputs/Reports/ relatório-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 ter mais informações, consulte Configurando critérios de sucesso para relatórios.

UI correspondente: guia Saída/Relatórios/Critérios de sucesso

PassRate

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ PassRate

(nome da ação nome do relatório-1/Outputs/Reports/) /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 incluem 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 obter mais informações sobre relatórios de teste, consulteRelatórios de teste.

UI correspondente: guia Saída/Relatórios/Critérios de sucesso/Taxa de aprovação

LineCoverage

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ LineCoverage

(nome da ação nome do relatório-1/Outputs/Reports/) /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 incluem 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 obter mais informações sobre relatórios de cobertura de código, consulteRelatórios de cobertura de código.

UI correspondente: guia de saída/relatórios/critérios de sucesso/cobertura de linha

BranchCoverage

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ BranchCoverage

(nome da ação nome do relatório-1/Outputs/Reports/) /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 incluem números decimais. Por exemplo: 50, 60.5. Os critérios de cobertura da filial são aplicados somente aos relatórios de cobertura de código. Para obter mais informações sobre relatórios de cobertura de código, consulteRelatórios de cobertura de código.

UI correspondente: guia de saída/relatórios/critérios de sucesso/cobertura de filiais

Vulnerabilities

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ Vulnerabilities

(nome da ação nome do relatório-1/Outputs/Reports/) /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, você deve especificar:

A gravidade mínima das vulnerabilidades que você deseja incluir na contagem. Os valores válidos, do mais para o menos severo, são: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Por exemplo, se você escolherHIGH, HIGH CRITICAL as vulnerabilidades serão contabilizadas.
O número máximo de vulnerabilidades da severidade 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 da SCA. Para obter mais informações sobre relatórios SCA, consulteRelatórios de análise de composição de software.

Para especificar a severidade mínima, use a Severity propriedade. Para especificar o número máximo de vulnerabilidades, use a Number propriedade.

UI correspondente: guia Saída/relatórios/critérios de sucesso/vulnerabilidades

StaticAnalysisBug

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisBug

(nome da ação nome do relatório-1/Outputs/Reports/) /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, você deve especificar:

A gravidade mínima dos bugs que você deseja incluir na contagem. Os valores válidos, do mais para o menos severo, são: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Por exemplo, se você escolherHIGH, HIGH os CRITICAL bugs serão computados.
O número máximo de bugs da severidade 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 aos PyLint relatórios da ESLint SA. Para obter mais informações sobre relatórios SA, consulteRelatórios de análise estática.

Para especificar a severidade mínima, use a Severity propriedade. Para especificar o número máximo de vulnerabilidades, use a Number propriedade.

UI correspondente: guia de saída/relatórios/critérios de sucesso/bugs

StaticAnalysisSecurity

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisSecurity

(nome da ação nome do relatório-1/Outputs/Reports/) /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, você deve especificar:

A gravidade mínima das vulnerabilidades de segurança que você deseja incluir na contagem. Os valores válidos, do mais para o menos severo, são: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Por exemplo, se você escolherHIGH, HIGH as vulnerabilidades CRITICAL de segurança serão computadas.
O número máximo de vulnerabilidades de segurança da severidade 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 relatórios PyLint da ESLint SA. Para obter mais informações sobre relatórios SA, consulteRelatórios de análise estática.

Para especificar a severidade mínima, use a Severity propriedade. Para especificar o número máximo de vulnerabilidades, use a Number propriedade.

UI correspondente: guia Saída/Relatórios/Critérios de sucesso/Vulnerabilidades de segurança

StaticAnalysisQuality

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisQuality

(nome da ação nome do relatório-1/Outputs/Reports/) /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, você deve especificar:

A gravidade mínima dos problemas de qualidade que você deseja incluir na contagem. Os valores válidos, do mais para o menos severo, são: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Por exemplo, se você escolherHIGH, HIGH os problemas CRITICAL de qualidade serão computados.
O número máximo de problemas de qualidade da severidade 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 aos PyLint relatórios da ESLint SA. Para obter mais informações sobre relatórios SA, consulteRelatórios de análise estática.

Para especificar a severidade mínima, use a Severity propriedade. Para especificar o número máximo de vulnerabilidades, use a Number propriedade.

UI correspondente: guia Saída/Relatórios/Critérios de sucesso/Problemas de qualidade

StaticAnalysisFinding

(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ StaticAnalysisFinding

(nome da ação nome do relatório-1/Outputs/Reports/) /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 as descobertas, você deve especificar:

A severidade mínima das descobertas que você deseja incluir na contagem. Os valores válidos, do mais para o menos severo, são: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Por exemplo, se você escolherHIGH, HIGH as CRITICAL descobertas serão computadas.
O número máximo de descobertas da severidade 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 da SARIF SA. Para obter mais informações sobre relatórios SA, consulteRelatórios de análise estática.

Para especificar a severidade mínima, use a Severity propriedade. Para especificar o número máximo de vulnerabilidades, use a Number propriedade.

UI correspondente: guia Saída/relatórios/critérios de sucesso/descobertas

Reports

(nome da ação) /Outputs/ Reports

(Optional)

Uma seção que especifica a configuração dos relatórios de teste.

UI correspondente: guia Saídas/Relatórios

nome do relatório-1

(nome da ação nome do relatório-1/Outputs/Reports/)

(Obrigatório se Reports estiver incluído)

O nome que você deseja dar ao CodeCatalyst relatório que será gerado a partir de seus relatórios brutos.

UI correspondente: guia Saídas/Relatórios/Configurar manualmente os relatórios/Nome do relatório

Format

(nome da ação nome do /Outputs/Reports/ relatório-1/) Format

(Obrigatório se Reports estiver incluído)

Especifique o formato de arquivo que você está usando para seus relatórios. Os valores possíveis são.

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, 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: guia Saídas/Relatórios/Configurar manualmente relatórios/Adicionar/configurar relatórios/nome-do-relatório-1/Tipo de relatório e formato do relatório

Configuration

(nome da ação/) Configuration

(Obrigatório) Uma seção na qual você pode definir as propriedades de configuração da ação.

UI correspondente: guia Configuração

Container

(nome da ação) /Configuration/ Container

(Optional)

Especifique a imagem do Docker, ou contêiner, que a ação usa para concluir seu processamento. Você pode especificar uma das imagens ativas que vêm com CodeCatalyst ela ou usar sua própria imagem. Se você optar por usar sua 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 seu processamento. Para obter informações sobre qual imagem ativa é usada por padrão, consulteImagens ativas.

Para obter mais informações sobre como especificar sua própria imagem do Docker, consulte. Atribuindo uma imagem Docker de um ambiente de tempo de execução personalizado a uma ação

UI correspondente: imagem Docker do ambiente de tempo de execução - opcional

Registry

(nome da ação) /Configuration/Container/ Registry

(Obrigatório se Container estiver incluído)

Especifique o registro em que sua 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, você deve criar uma função do IAM que inclua as seguintes permissões e a política de confiança personalizada. (Você pode modificar uma função existente para incluir as permissões e a política, se quiser.)

A função do IAM deve incluir as seguintes permissões em sua política de função:
- ecr:BatchCheckLayerAvailability
- ecr:BatchGetImage
- ecr:GetAuthorizationToken
- ecr:GetDownloadUrlForLayer
A função do IAM deve incluir a seguinte política de confiança personalizada:
```
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}
```
Para obter mais informações sobre a criação de funções do IAM, consulte Como criar uma função usando políticas de confiança personalizadas (console) no Guia do usuário do IAM.

Depois de criar a função, você deve atribuí-la à ação por meio de um ambiente. Para ter mais informações, consulte Associando um ambiente a uma ação de fluxo de trabalho.

UI correspondente: Amazon Elastic Container Registry, Docker Hub e outras opções de registro

Image

(nome da ação) /Configuration/Container/ Image

(Obrigatório se Container estiver incluído)

Especifique um dos seguintes:

Se você estiver usando um CODECATALYST registro, defina a imagem como uma das seguintes imagens ativas:
- 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 com o nome da imagem do Docker Hub e a tag opcional.

Exemplo: postgres:latest
Se você 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 você estiver usando um registro personalizado, defina a imagem com o valor esperado pelo registro personalizado.

UI correspondente: imagem docker do ambiente de tempo de execução (se o registro forCODECATALYST), imagem do Docker Hub (se o registro for Docker Hub), URL da imagem ECR (se o registro for Amazon Elastic Container Registry) e URL da imagem (se o registro for Outro registro).

Steps

(nome da ação) /Configuration/ Steps

(Obrigatório)

Especifique os comandos do shell que você deseja executar durante a ação para instalar, configurar e executar suas ferramentas de compilação.

Aqui está um exemplo de como criar um projeto npm:


Steps:
  - Run: npm install
  - Run: npm run build

Aqui está 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 obter mais informações sobre como especificar caminhos de arquivo, consulte Fazendo referência a arquivos em um repositório de origem e. Fazendo referência a arquivos em um artefato

UI correspondente: guia de configuração/comandos Shell

Packages

(nome da ação) /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 aplicativos.

Para obter mais informações sobre pacotes, consultePublique e compartilhe pacotes de software no CodeCatalyst.

UI correspondente: guia de configuração/pacotes

NpmConfiguration

(nome da ação) /Configuration/Packages/ NpmConfiguration

(Obrigatório se Packages estiver 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 obter mais informações sobre a configuração do pacote npm, consulteUso de npm.

UI correspondente: guia de configuração/pacotes/Adicionar configuração/ npm

PackageRegistries

(nome da ação) /Configuration/Packages/NpmConfiguration/ PackageRegistries

(Obrigatório se Packages estiver 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: guia de configuração/pacotes/Adicionar configuração/npm/Adicionar repositório de pacotes

PackagesRepository

(nome da ação) /Configuration/Packages/NpmConfiguration/PackageRegistries/ PackagesRepository

(Obrigatório se Packages estiver 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 obter mais informações sobre repositórios de pacotes, consulteRepositórios de pacotes.

UI correspondente: guia Configuração/Pacotes/Adicionar configuração/npm/Adicionar repositório de pacotes/Repositório de pacotes

Scopes

(nome da ação) /Configuration/Packages/NpmConfiguration/PackageRegistries/ Scopes

(Optional)

Especifique uma sequência de escopos que você deseja definir no registro do pacote. Ao definir 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 ser prefixado com “@”.

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 obter mais informações sobre escopos, consulte Namespaces de pacotes Pacotes com escopo definido.

UI correspondente: guia de configuração/pacotes/Adicionar configuração/npm/Adicionar repositório de pacotes/escopos - opcional

ExportAuthorizationToken

(nome da ação) /Configuration/Packages/ ExportAuthorizationToken

(Optional)

Ative ou desative 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. Você pode usar o token como uma variável de ambiente que pode ser referenciada em suas ações.

Os valores válidos são true ou false.

Se ExportAuthorizationToken for omitido, o padrão será. false

Para obter mais informações sobre o token de autorização de exportação, consulteUsando tokens de autorização em ações de fluxo de trabalho.

UI correspondente: guia de configuração/pacotes/token de autorização de exportação

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Tutorial: Faça upload de artefatos para o Amazon S3

Testando com fluxos de trabalho