Sobre ações personalizadas
Você pode criar ações escrevendo código personalizado que interage com seu repositório da maneira que desejar, incluindo a integração com GitHubAPIs e qualquer API de terceiros publicamente disponível. Por exemplo, uma ação pode publicar módulos npm, enviar alertas de SMS quando problemas urgentes surgirem ou implantar o código pronto para produção.
Você pode escrever suas próprias ações para usar em seu fluxo de trabalho ou compartilhar as ações que cria com a GitHub comunidade. Para compartilhar as ações que você criou com todas as pessoas, seu repositório deve ser público.
As ações podem ser executadas diretamente em uma máquina ou em um contêiner Docker. É possível definir as entradas, saídas e variáveis do ambiente de uma ação.
Tipos de ações
Observação
Você pode criar um contêiner do Docker, JavaScript e ações compostas. As ações exigem um arquivo de metadados para definir a configuração de entradas, saídas e execuções para sua ação. Os arquivos de metadados de ação usam a sintaxe YAML e o nome do arquivo de metadados deve ser action.yml ou action.yaml. O formato preferencial é action.yml.
| Tipo | Linux | macOS | Windows |
|---|---|---|---|
| contêiner do Docker | |||
| JavaScript | |||
| Ações compostas |
Ações de contêiner do Docker
Os contêineres do Docker empacotam o ambiente com o GitHub Actions código. Esse procedimento cria uma unidade de trabalho mais consistente e confiável, pois o consumidor da ação não precisa se preocupar com ferramentas ou dependências.
Um contêiner Docker permite usar versões específicas de um sistema operacional, bem como as dependências, as ferramentas e o código. Para ações a serem executadas em uma configuração específica de ambiente, o Docker é a opção ideal porque permite personalizar o sistema operacional e as ferramentas. Por causa da latência para compilar e recuperar o contêiner, as ações de contêiner Docker são mais lentas que as ações JavaScripts.
As ações do contêiner Docker podem apenas ser executadas em executores com o sistema operacional Linux. Executores auto-hospedados devem usar um sistema operacional Linux e ter o Docker instalado para executar as ações do contêiner Docker. Para obter mais informações sobre os requisitos dos runners auto-hospedados, confira Executores auto-hospedados.
Ações de JavaScript
As ações do JavaScript podem ser executadas diretamente em uma máquina executora e separar o código de ação do ambiente usado para executar o código. Usar ações JavaScript simplifica o código da ação e é um processo mais rápido se comparado à opção do contêiner Docker.
Para garantir que suas ações de JavaScript sejam compatíveis com todos os executores hospedados no GitHub (Ubuntu, Windows e macOS), o código JavaScript empacotado que você escreve deve ser JavaScript puro e não depender de outros binários. As ações JavaScript são executadas diretamente no executor e usam binários que já existem na imagem do executor.
Se você estiver desenvolvendo um projeto Node.js, o GitHub Actions Kit de Ferramentas fornecerá pacotes que você pode usar em seu projeto para acelerar o desenvolvimento. Para obter mais informações, confira o repositório actions/toolkit.
Ações compostas
Uma ação composta permite combinar várias etapas de fluxo de trabalho em uma ação. Por exemplo, você pode usar esse recurso para juntar vários comandos executando em uma ação e, em seguida, ter um fluxo de trabalho que executa os comandos empacotados como uma única etapa usando essa ação. Para ver um exemplo, confira Criar uma ação composta.
Próximas etapas
Para saber mais sobre como gerenciar suas ações personalizadas, consulte Como gerenciar ações personalizadas.