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á.
Definição YAML da GitHub ação “Ações”
A seguir está a definição YAML da ação GitHubAções.
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/github-actions-runner@v1
DependsOn:
- dependent-action-name-1
Compute:
Fleet: fleet-name
Timeout: timeout-minutes
Environment:
Name: environment-name
Connections:
- Name: account-connection-name
Role: iam-role-name
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:
- github-output/artifact-1.jar
- "github-output/build*"
- Name: output-artifact-2
Files:
- github-output/artifact-2.1.jar
- github-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
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
Configuration
Steps:
- github-actions-code
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/github-actions-runner@v1
para GitHubações.
UI correspondente: diagrama de fluxo de trabalho/nome da ação/ rótulo aws/
@v1 github-actions-runner
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
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 é concluída. 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 - opcional
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 é o mesmo que o 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.
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/conta/função
Name
(nome da ação) /Environment/ Name
(Obrigatório se Environment estiver incluído)
Especifique o nome de um ambiente existente que você deseja associar à ação.
UI correspondente: guia de configuração/'Ambiente/Conta/Função'/Ambiente
Connections
(nome da ação) /Environment/ Connections
(Obrigatório se Environment estiver incluído)
Especifique a conexão da conta a ser associada à ação. Você pode especificar no máximo uma conexão de conta emEnvironment
.
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 associar uma conexão de conta ao seu ambiente, consulteCriar um ambiente.
UI correspondente: nenhuma
Name
(nome da ação) /Environment/Connections/ Name
(Optional)
Especifique o nome da conexão da conta.
UI correspondente: guia de configuração/'Ambiente/conta/função'/ conexão AWS de conta
Role
(nome da ação) /Environment/Connections/ Role
(Optional)
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 à conexão da sua conta. Para adicionar uma função do IAM a uma conexão de conta, consulteAdicionar funções do IAM às conexões da conta.
nota
Você pode especificar o nome da CodeCatalystWorkflowDevelopmentRole-
função aqui, desde que ela tenha permissões suficientes. Para obter mais informações sobre essa função, consulte Criando a CodeCatalystWorkflowDevelopmentRole-spaceNamefunção para sua conta e espaço. Entenda que a spaceName
CodeCatalystWorkflowDevelopmentRole-
função tem permissões muito amplas que podem 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. spaceName
Atenção
Limite as permissões às exigidas pela GitHub ação Ação. Usar uma função com permissões mais amplas pode representar um risco de segurança.
UI correspondente: guia Configuração/'Ambiente/Conta/Função'/Função
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 GitHub ação de Ações. 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: guia Entradas/Fontes - opcional
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)
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/Adicionar artefato/Criar nome do artefato
Files
(nome da ação) /Outputs/Artifacts/ Files
(Obrigatório se Artifacts - output estiver 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 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
oudirectory/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/Adicionar artefato/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: nenhuma
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/Descubra relatórios automaticamente
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 Saídas/Relatórios/Descoberta automática de relatórios/Prefixo do relatório
IncludePaths
(nome da ação) /Outputs/AutoDiscoverReports/ IncludePaths
Ou
(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/Descubra relatórios automaticamente/'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
Ou
(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
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.
UI correspondente:
-
Guia de saídas/Relatórios/Descubra relatórios automaticamente/'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
Ou
(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ídas/Relatórios/Descubra relatórios automaticamente/Critérios de sucesso
-
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1/Critérios de sucesso
PassRate
(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ PassRate
Ou
(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ídas/Relatórios/Descobrir relatórios automaticamente/Critérios de sucesso/Taxa de aprovação
-
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1 /Critérios de sucesso/ Taxa de aprovação
LineCoverage
(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ LineCoverage
Ou
(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 Saídas/Relatórios/Descubra automaticamente os relatórios/Critérios de sucesso/Cobertura de linha
-
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1 /Critérios de sucesso/ Cobertura de linha
BranchCoverage
(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ BranchCoverage
Ou
(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 Saídas/Relatórios/Descubra relatórios automaticamente/Critérios de sucesso/Cobertura de filiais
-
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1 /Critérios de sucesso/ Cobertura da filial
Vulnerabilities
(nome da ação) /Outputs/AutoDiscoverReports/SuccessCriteria/ Vulnerabilities
Ou
(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:
CRITICAL
HIGH
,MEDIUM
,,LOW
,INFORMATIONAL
.Por exemplo, se você escolher
HIGH
,HIGH
CRITICAL
as vulnerabilidades serão computadas. -
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.
Para obter mais informações sobre relatórios SCA, consulteTipos de relatório de qualidade.
UI correspondente:
-
Guia Saídas/Relatórios/Descubra automaticamente os relatórios/Critérios de sucesso/Vulnerabilidades
-
Guia Saídas/Relatórios/Configurar manualmente os relatórios/nome-do-relatório-1 /Critérios de sucesso/ Vulnerabilidades
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 os relatórios/Adicionar relatório/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
Steps
(nome da ação) /Configuration/ Steps
(Obrigatório)
Especifique seu código de GitHub ação conforme ele aparece na página de detalhes da ação no GitHub Marketplace
-
Cole o código da
steps:
seção GitHub Ação naSteps:
seção do CodeCatalyst fluxo de trabalho. O código começa com um traço (-) e é semelhante ao seguinte.GitHub código para colar:
- name: Lint Code Base uses: github/super-linter@v4 env: VALIDATE_ALL_CODEBASE: false DEFAULT_BRANCH: master GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
Revise o código que você acabou de colar e modifique-o conforme necessário para que esteja em conformidade com os CodeCatalyst padrões. Por exemplo, com o bloco de código anterior, você pode remover o código em
itálico vermelho
e adicionar o código em negrito.CodeCatalyst fluxo de trabalho yaml:
Steps: - name: Lint Code Base uses: github/super-linter@v4 env: VALIDATE_ALL_CODEBASE: false DEFAULT_BRANCH:
master
mainGITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
Para obter código adicional incluído na GitHub Ação, mas que não existe dentro da
steps:
seção, adicione-o ao CodeCatalyst fluxo de trabalho usando o código CodeCatalyst -equivalent. Você pode revisar o Definição de fluxo de trabalho YAML para obter informações sobre como você pode portar seu GitHub código para CodeCatalyst o. As etapas detalhadas de migração estão fora do escopo deste guia.
Aqui está um exemplo de como especificar caminhos de arquivo em uma ação de GitHub ações:
Steps:
- name: Lint Code Base
uses: github/super-linter@v4
...
- run: cd /sources/WorkflowSource/MyFolder/ && cat file.txt
- run: cd /artifacts/MyGitHubAction/MyArtifact/MyFolder/ && cat file2.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 GitHub configuração/ações YAML