Aprovando e mantendo ações

Você pode aproveitar a automação e as práticas recomendadas de código aberto para lançar e manter ações.

Neste artigo

Introdução

Depois de criar uma ação, você irá continuar lançando novas funcionalidades enquanto trabalha com contribuições da comunidade. Este tutorial descreve um exemplo de processo que você pode seguir para lançar e manter as ações em código aberto. O exemplo:

  • Aproveita GitHub Actions para integração contínua, atualizações de dependência, gerenciamento de versões e automação de tarefas.
  • Fornece confiança por meio de testes automatizados e cria selos.
  • Indica como a ação pode ser usada, de preferência como parte de um fluxo de trabalho mais amplo.
  • Sinaliza que tipo de contribuições da comunidade você recebe. (Por exemplo, problemas, pull requests ou relatórios de vulnerabilidade.)

Para ver um exemplo aplicado desse processo, confira actions/javascript-action.

Desenvolver e lançar ações

Nesta seção, discutimos um processo exemplo para desenvolver e lançar ações e mostrar como usar GitHub Actions para automatizar o processo.

Sobre ações do JavaScript

As ações do JavaScript são repositórios do Node.js com metadados. No entanto, as ações do JavaScript têm propriedades adicionais comparadas aos projetos tradicionais do Node.js:

  • Os pacotes dependentes recebem commit ao lado do código, normalmente em uma forma compilada e minificada. Isto significa que as criações automatizadas e as contribuições seguras da comunidade são importantes.

  • As versões marcadas podem ser publicadas diretamente em GitHub Marketplace e consumidas pelos fluxos de trabalho em GitHub.

  • Muitas ações fazem uso de APIs de GitHub e de terceiros, por isso incentivamos testes robustos de ponta a ponta.

Configurando fluxos de trabalho de GitHub Actions

Para apoiar o processo de desenvolvedor na próxima seção, adicione dois fluxos de trabalho de GitHub Actions ao seu repositório:

  1. Adicione um fluxo de trabalho que é disparado quando um commit é enviado por push para um branch de recursos ou para main ou quando uma solicitação de pull é criada. Configure o fluxo de trabalho para executar seus testes de unidade e integração. Para ver um exemplo, confira este fluxo de trabalho.
  2. Adicione um fluxo de trabalho que é acionado quando uma versão é publicada ou editada. Configure o fluxo de trabalho para garantir que as tags semânticas estejam prontas. Use uma ação como JasonEtco/build-and-tag-action para compilar e empacotar o arquivo JavaScript e de metadados e forçar o push das tags semânticas principal, secundário e de patch. Para obter mais informações sobre tags semânticas, confira Sobre o controle de versão semântico.

Exemplo do processo de desenvolvedor

Este é um exemplo de processo que você pode seguir para executar testes automaticamente, criar uma versão e publicá-la no GitHub Marketplace e publicar sua ação.

  1. Faça o trabalho de recurso nos branches por fluxo do GitHub. Para saber mais, confira Fluxo do GitHub.

    • Sempre que um commit é enviado por push para o branch de recurso, seu fluxo de trabalho de teste irá executar os testes automaticamente.

  2. Crie solicitações de pull para o branch main a fim de iniciar a discussão e a revisão, mesclando-as quando estiverem prontas.

    • Quando um pull request é aberto, seja em um branch ou bifurcação, seu fluxo de trabalho de testes executará novamente os testes, desta vez com o commit do merge.

    • Observação: por motivos de segurança, os fluxos de trabalho disparados por pull_request por meio de forks têm permissões GITHUB_TOKEN restritas e não têm acesso aos segredos. Se os testes ou outros fluxos de trabalho disparados após a solicitação de pull exigirem acesso aos segredos, considere o uso de outro evento, como um gatilho manual ou um pull_request_target. Para saber mais, confira Eventos que disparam fluxos de trabalho.

  3. Crie uma versão semântica marcada. Você também pode publicá-los no GitHub Marketplace com uma caixa de seleção simples. Para saber mais, confira Gerenciar versões em repositórios e Publicar ações no GitHub Marketplace.

    • Quando uma versão é publicada ou editada, seu fluxo de trabalho de versão cuidará automaticamente da compilação e ajuste das tags.

    • Recomendamos criar versões usando tags com controle de versão semântico (por exemplo, v1.1.3) e manter as tags de principal (v1) e secundário (v1.1) atuais com o último commit apropriado. Para saber mais, confira Sobre ações personalizadas e Sobre o controle de versão semântico.

Resultados

Ao contrário de algumas outras estratégias de gerenciamento de versão automatizadas, esse processo intencionalmente não faz commit das dependências no branch main, apenas para os commits de versão marcados. Ao fazer isso, você incentiva os usuários da sua ação a referenciar os shas ou as tags nomeadas e ajuda a garantir a segurança das solicitações de pull de terceiros fazendo o build por conta própria durante uma versão.

Usar versões semânticas significa que os usuários das suas ações podem fixar os seus fluxos de trabalho a uma versão e saber que podem continuar recebendo a última estabilidade recursos não relevantes, dependendo de seu nível de conforto.

Trabalhando com a comunidade

GitHub fornece ferramentas e guias para ajudar você a trabalhar com a comunidade de código aberto. Aqui estão algumas ferramentas que recomendamos a criação de uma comunicação bidirecional saudável. Ao fornecer os seguintes sinais à comunidade, você incentiva outras pessoas a usar, modificar e contribuir para sua ação:

Leitura adicional

Os exemplos em que os padrões similares são empregados incluem: