Uma Ação do GitHub é muito parecida com uma Ação CodeCatalyst, exceto pelo fato de ter sido desenvolvida para uso com fluxos de trabalho do GitHub. Para ter detalhes sobre o GitHub Actions, consulte a documentação do GitHub Actions
Você pode usar o GitHub Actions com as ações nativas do CodeCatalyst em um fluxo de trabalho do CodeCatalyst.
Há duas maneiras de adicionar uma ação do GitHub a um fluxo de trabalho do CodeCatalyst:
-
Você pode selecionar a ação do GitHub em uma lista selecionada no console do CodeCatalyst. Várias ações populares do GitHub estão disponíveis. Para ter mais informações, consulte Adição de uma ação selecionada do GitHub.
-
Se a ação do GitHub que deseja usar não estiver disponível no console do CodeCatalyst, você poderá adicioná-la usando uma ação GitHub Actions.
Uma ação GitHub Actions é uma ação do CodeCatalyst que encapsula uma ação do GitHub e a torna compatível com os fluxos de trabalho do CodeCatalyst.
Confira um exemplo de uma ação GitHub Actions envolvendo a ação do GitHub Super-Linter
: Actions: GitHubAction: Identifier: aws/github-actions-runner@v1 Configuration: Steps: - name: Lint Code Base uses: github/super-linter@v4 env: VALIDATE_ALL_CODEBASE: "true" DEFAULT_BRANCH: main
No código anterior, a ação GitHub Actions do CodeCatalyst (identificada por
aws/github-actions-runner@v1
) envolve a ação Super-Linter (identificada porgithub/super-linter@v4
), fazendo com que ela funcione em um fluxo de trabalho do CodeCatalyst.Para ter mais informações, consulte Adição da ação “GitHub Actions”.
Todas as ações do GitHub, selecionadas ou não, devem ser agrupadas em uma ação GitHub Actions (aws/github-actions-runner@v1
), conforme mostrado no exemplo anterior. O invólucro é necessário para a ação funcionar bem.
Tópicos
- Como o GitHub Actions é diferente das ações do CodeCatalyst?
- O GitHub Actions pode interagir com outras ações do CodeCatalyst no fluxo de trabalho?
- Quais GitHub Actions posso usar?
- Limitações do GitHub Actions no CodeCatalyst
- Como adiciono uma ação do GitHub (etapas de alto nível)?
- A ação do GitHub é executada no GitHub?
- Também posso usar os fluxos de trabalho do GitHub?
- Imagem de runtime usada pela ação “GitHub Actions”
- Tutorial: código Lint usando uma ação do GitHub
- Adição da ação “GitHub Actions”
- Adição de uma ação selecionada do GitHub
- Exportação dos parâmetros de saída do GitHub
- Referência aos parâmetros de saída do GitHub
- YAML da ação “GitHub Actions”
Como o GitHub Actions é diferente das ações do CodeCatalyst?
As ações do GitHub que são usadas dentro de um fluxo de trabalho do CodeCatalyst não têm o mesmo nível de acesso e integração com a AWS e os recursos do CodeCatalyst (como ambientes e problemas) que as ações do CodeCatalyst.
O GitHub Actions pode interagir com outras ações do CodeCatalyst no fluxo de trabalho?
Sim. Por exemplo, o GitHub Actions pode usar variáveis produzidas por outras ações do CodeCatalyst como entrada e também pode compartilhar parâmetros e artefatos de saída com ações do CodeCatalyst. Para ter mais informações, consulte Exportação dos parâmetros de saída do GitHub e Referência aos parâmetros de saída do GitHub.
Quais GitHub Actions posso usar?
Você pode usar qualquer ação do GitHub disponível por meio do console do CodeCatalyst e qualquer ação do GitHub disponível no GitHub Marketplace
Limitações do GitHub Actions no CodeCatalyst
-
O GitHub Actions não pode ser usado com o tipo de computação Lambda do CodeCatalyst.
-
O GitHub Actions é executado na imagem do Docker do runtime de novembro de 2022, que inclui ferramentas mais antigas. Para ter mais informações sobre a imagem e as ferramentas, consulte Especificação de imagens de ambiente de runtime.
-
As ações do GitHub que dependem internamente do contexto do
github
ou que fazem referência a recursos específicos do GitHub não funcionarão no CodeCatalyst. Por exemplo, as seguintes ações não funcionarão no CodeCatalyst: -
Ações que tentam adicionar, alterar ou atualizar recursos do GitHub. Os exemplos incluem ações que atualizam solicitações pull ou criam problemas no GitHub.
-
Quase todas as ações estão listadas em https://github.com/actions
.
-
-
As ações do GitHub que são ações de contêiner do Docker
funcionarão, mas elas devem ser executadas pelo usuário padrão do Docker (raiz). Não execute a ação como usuário 1001. (No momento em que este artigo foi escrito, o usuário 1001 funcionava no GitHub, mas não no CodeCatalyst.) Para obter mais informações, consulte o tópico USER em Dockerfile support for GitHub Actions
Para ver uma lista das ações do GitHub disponíveis por meio do console do CodeCatalyst, consulte Adição de uma ação selecionada do GitHub.
Como adiciono uma ação do GitHub (etapas de alto nível)?
As etapas de alto nível para adicionar uma ação do GitHub a um fluxo de trabalho do CodeCatalyst são as seguintes:
-
No projeto do CodeCatalyst, você cria um fluxo de trabalho. No fluxo de trabalho, você define como criar, testar e implantar a aplicação. Para ter mais informações, consulte Conceitos básicos de fluxos de trabalho.
-
No fluxo de trabalho, você adiciona uma ação selecionada do GitHub ou adiciona a ação do GitHub Actions.
-
Realize uma das seguintes ações:
-
Se você optar por adicionar uma ação selecionada, configure-a. Para ter mais informações, consulte Adição de uma ação selecionada do GitHub.
-
Se você optar por adicionar uma ação não selecionada, na ação GitHub Actions, cole o código YAML da ação do GitHub. Você pode encontrar esse código na página de detalhes da ação do GitHub escolhida no GitHub Marketplace
. Provavelmente, você precisará modificar um pouco o código para que ele funcione no CodeCatalyst. Para ter mais informações, consulte Adição da ação “GitHub Actions”.
-
-
(Opcional) No fluxo de trabalho, adicione outras ações, como as ações de criação e teste. Para ter mais informações, consulte Compilação, teste e implantação com fluxos de trabalho.
-
Você inicia o fluxo de trabalho manual ou automaticamente por meio de um gatilho. O fluxo de trabalho executa a ação do GitHub e quaisquer outras ações no fluxo de trabalho. Para ter mais informações, consulte Iniciar um fluxo de trabalho executado manualmente.
Para saber detalhes das etapas, consulte:
A ação do GitHub é executada no GitHub?
Não. A ação do GitHub é executada no CodeCatalyst, usando a imagem do ambiente de runtime do CodeCatalyst.
Também posso usar os fluxos de trabalho do GitHub?
Não.
Imagem de runtime usada pela ação “GitHub Actions”
A ação GitHub Actions do CodeCatalyst é executada em uma imagem de novembro de 2022. Para ter mais informações, consulte Imagens ativas.