Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Sintaxe de metadados para o GitHub Actions

Você pode criar ações para executar tarefas no repositório. As ações requerem um arquivo de metadados que usa sintaxe YAML.

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub One. GitHub Actions is not available for private repositories owned by accounts using legacy per-repository plans. For more information, see "GitHub's products."

Neste artigo

Sobre sintaxe YAML para o GitHub Actions

Ações Docker e JavaScript requerem um arquivo de metadados. The metadata filename must be either action.yml or action.yaml. Os dados no arquivo de metadados definem as entradas, as saídas e o ponto de entrada principal para sua ação.

Arquivos de metadados de ação usam a sintaxe YAML. Se você não souber o que é YAML, consulte "Aprender a usar YAML em cinco minutos".

name

Necessário: nome de sua ação. O GitHub exibe o name (nome) na aba Actions (Ações) para facilitar a identificação visual das ações em cada trabalho.

autor

Opcional: nome do autor da ação.

descrição

Necessário: uma descrição curta da ação.

inputs

Opcional: parâmetros de entrada permitem que você especifique os dados que a ação espera usar no momento da execução. O GitHub armazena parâmetros como variáveis de ambiente. Identificações de entrada com letras maiúsculas são alteradas para letras minúsculas no momento da execução. Recomenda-se usar identificações de entrada com letras minúsculas.

Exemplo

Este exemplo configura duas entradas: numOctocats e octocatEyeColor. A entrada numOctocats não é necessária e assumirá o valor '1'. A entrada octocatEyeColor é necessária e não tem valor padrão. Arquivos de fluxo de trabalho que usam essa ação devem usar a palavra-chave with (com) para definir um valor de entrada para octocatEyeColor. Para obter mais informações sobre a sintaxe with (com), consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

inputs:
  numOctocats:
    description: 'Number of Octocats'
    required: false
    default: '1'
  octocatEyeColor:
    description: 'Eye color of the Octocats'
    required: true

Quando você especifica uma entrada para uma ação em um arquivo de fluxo de trabalho ou usa um valor de entrada padrão, o GitHub cria uma variável de ambiente para a entrada com o nome INPUT_<VARIABLE_NAME>. A variável de ambiente criada altera os nomes de entrada para letras maiúsculas e substitui espaços por caracteres _.

Por exemplo, se um fluxo de trabalho definiu as entradas numOctocats e octocatEyeColor, o código da ação lê os valores das entradas usando as variáveis de ambiente INPUT_NUMOCTOCATS e INPUT_OCTOCATEYECOLOR.

inputs.<input_id>

Necessário: um identificador string para associar à entrada. O valor de <input_id> é um mapa dos metadados da entrada. <input_id> deve ser um identificador único dentro do objeto inputs (entradas). <input_id> deve iniciar com uma letra ou _ e conter somente caracteres alfanuméricos, - ou _.

inputs.<input_id>.description

Necessário: descrição de string do parâmetro de entrada.

inputs.<input_id>.required

Necessário: um boolean (booleano) para indicar se a ação requer o parâmetro de entrada. Defina para true quando o parâmetro for necessário.

inputs.<input_id>.default

Opcional: uma string que representa o valor padrão. O valor padrão é usado quando um parâmetro de entrada não é especificado em um arquivo de fluxo de trabalho.

outputs

Optional Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. Por exemplo, se uma ação executou a adição de duas entradas (x + y = z), a ação poderia usar o resultado da soma (z) como entrada em outras ações.

If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow. For more information on setting outputs in an action, see "Development tools for GitHub Actions."

Example

outputs:
  sum: # id of the output
    description: 'The sum of the inputs'

outputs.<output_id>

Necessário: um identificador string para associar à saída. O valor de <output_id> é um mapa dos metadados de saída. <output_id> deve ser um identificador único dentro do objeto outputs (saídas). <output_id> deve iniciar com uma letra ou _ e conter somente caracteres alfanuméricos, - ou _.

outputs.<output_id>.description

Necessário: descrição de string do parâmetro de saída.

runs (execuções)

Necessário: comando para executar quando a ação executa.

using

Necessário: aplicativo que se deve usar para executar o código especificado em main (principal).

Exemplo usando Node.js
using: 'node12'
main: 'main.js'
Exemplos usando Dockerfile no repositório
using: 'docker'
image: 'Dockerfile'
using: 'docker'
image: 'docker://debian:stetch-slim'

env

Optional for container actions Specifies a key/value map of environment variables to set in the container environment.

main

Necessário para ações JavaScript: arquivo de código que contém o código da ação. O aplicativo especificado com a sintaxe using executará esse arquivo.

imagem

Necessário para ações de contêiner: imagem Docker para usar com o contêiner para executar a ação. O valor pode ser o nome da imagem de base do Docker, um Dockerfile no repositório, um Hub ou registro público Docker. To reference a Dockerfile local to your repository, use a path relative to your action metadata file. O aplicativo especificado com a sintaxe using executará esse arquivo.

Exemplos de uso de Dockerfile no repositório
image: 'Dockerfile'
Exemplo usando um contêiner de registro Docker público
image: 'docker://debian:stretch-slim'

entrypoint

Opcional para ações de contêiner: anula o ENTRYPOINT Docker no Dockerfile ou define-o caso ainda não tenha sido especificado. Se uma ação não usa a palavra-chave runs (execuções), os comandos no entrypoint executarão. A instrução Docker ENTRYPOINT tem um formulário shell e um formulário de execução. A documentação Docker ENTRYPOINT recomenda o uso do formulário de execução da instrução ENTRYPOINT.

args

Opcional para ações de contêiner: um array of strings (array de strings) que define as entradas para um contêiner Docker. As entradas podem incluir strings com codificação rígida. O GitHub entrega os args ao ENTRYPOINT do contêiner quando o contêiner inicia.

args são usados em substituição à instrução CMD em um Dockerfile. Se você usar CMD no Dockerfile, use as diretrizes ordenadas por preferência:

  1. Documente os argumentos necessários no LEIAME das ações e omita-os da instrução CMD.
  2. Use padrões que permitam o uso da ação sem especificação de args.
  3. Se a ação expõe um sinalizador --help ou similar, use isso como padrão para que a ação se documente automaticamente.
Example
# formato de array
args: ['${{ inputs.greeting }}', 'foo', 'bar']

# e por ser apenas YAML, isso funciona:
args:
  - ${{ inputs.greeting }}
  - 'foo'
  - 'bar'

branding

You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.

Exemplo

branding:
  icon: 'award'  
  color: 'green'

color

Cor de fundo do selo. Pode ser: branco, amarelo, azul, verde, laranja, vermelho, roxo ou cinza-escuro.

icon

Nome do ícone Feather (pena) para usar.

atividade frequência de execução alerta-círculo alerta-octágono
alerta-triângulo alinhar-centro alinhar-justificar alinhar-esquerda
alinhar-direita âncora abertura arquivar
flecha-abaixo-círculo flecha-abaixo-esquerda flecha-abaixo-direita flecha-abaixo
flecha-esquerda-círculo flecha-esquerda flecha-direita-círculo flecha-direita
flecha-acima-círculo flecha-acima-esquerda flecha-acima-direita flecha-acima
arroba prêmio barra-quadro-2 barra-quadro
bateria-carregando bateria sino-desativado sino
bluetooth negrito livro-aberto livro
favorito caixa pasta calendário
câmera-desligada câmera molde marcar-círculo
marcar-quadrado marcar chevron-abaixo chevron-esquerda
chevron-direita chevron-acima chevrons-abaixo chevrons-esquerda
chevrons-direita chevrons-acima círculo clipboard
relógio nuvem-chuvisco nuvem-relâmpago nuvem-desativada
nuvem-chuva nuvem-neve nuvem código
comando bússula copy canto-abaixo-esquerda
canto-abaixo-direita canto-esquerda-abaixo canto-esquerda-acima canto-direita-abaixo
canto-direita-acima canto-acima-esquerda canto-acima-direita cpu
cartão-de-crédito cortar mira banco de dados
delete disco dólar-sinal download-nuvem
download gota editar-2 editar-3
edit link-externo olho-fechado olho
facebook fast-forward pena arquivo-menos
arquivo-mais arquivo-texto arquivo filme
filtro sinalizador pasta-menos pasta-mais
pasta presente git-branch git-commit
git-merge git-pull-request globo grade
disco-rígido hash fones-de-ouvido coração
ajuda-círculo casa imagem caixa de entrada
info itálico camadas layout
boia salva-vidas link-2 link lista
carregador bloquear log-in log-out
correio fixar-mapa map maximizar-2
maximizar menu mensagem-círculo mensagem-quadrado
microfone-desligado microfone minimizar-2 minimizar
menos-círculo menos-quadrado menos monitor
lua mais-horizontal mais-vertical mover
música navegação-2 navegação octágono
pacote clips de papel pausa-círculo pausa
porcentagem chamada-telefônica telefone-transferência telefone-entrada
telefone-perdido telefone-desligado telefone-fora telefone
gráfico-pizza reproduzir-círculo reproduzir mais-círculo
mais-quadrado mais bolso energia
impressora rádio atualizar-ccw atualizar-cw
repetir retroceder girar-ccw girar-cw
rss salvar tesoura pesquisar
enviar servidor settings compartilhar-2
compartilhar escudo-desabilitado escudo sacola-de-compras
carrinho-de-compras aleatório barra lateral pular-atrás
pular-frente barra cursor smartphone
alto-falante quadrado estrela parar-círculo
sol nascer-do-sol pôr-do-sol tablet
tag target terminal termômetro
polegar-para-baixo polegar-para-cima alternar-esquerda alternar-direita
lixeira-2 lixeira tendência-baixa tendência-alta
triângulo caminhão tv tipo
guarda-chuva sublinhar desbloquear carregar-nuvem
fazer upload usuário-marcar usuário-menos usuário-mais
usuário-x usuário usuários vídeo-desligado
vídeo correio de voz volume-1 volume-2
volume-x volume inspecionar wifi-desligado
wifi vento x-círculo x-quadrado
x zapear-desligado zapear aproximar
afastar

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato