Skip to main content

Publicar ações no GitHub Marketplace

Você pode publicar ações em GitHub Marketplace e compartilhar as ações que você criou com a comunidade GitHub.

Pré-requisitos

Observação

Você deve aceitar os termos de serviço para publicar ações em GitHub Marketplace.

Antes de poder publicar uma ação, você deverá criar uma ação no seu repositório. Para saber mais, confira Reutilização de automações.

Ao planejar a publicação da ação no GitHub Marketplace, verifique se o repositório inclui apenas o arquivo de metadados, o código e os arquivos necessários para ela. Criar um repositório único para a ação permite que você identifique, lance e empacote o código em uma única unidade. GitHub também usa os metadados da ação na sua página GitHub Marketplace.

As ações são publicadas em GitHub Marketplace imediatamente e não são revisadas por GitHub, desde que esses requisitos sejam satisfeitos:

  • A ação precisa estar em um repositório público.
  • Cada repositório precisa conter um só arquivo de metadados de ação (action.yml ou action.yaml) na raiz.
    • Os repositórios podem incluir outros arquivos de metadados de ações em subpastas, mas eles não serão listados automaticamente no marketplace.
  • Cada repositório não deve conter nenhum arquivo de fluxo de trabalho.
  • O arquivo de metadados da ação name precisa ser exclusivo.
    • O name não pode corresponder a um nome de ação existente publicado no GitHub Marketplace.
    • O name não pode corresponder a um usuário ou a uma organização do GitHub, a menos que o usuário ou o proprietário da organização esteja publicando a ação. Por exemplo, somente a organização do GitHub pode publicar uma ação chamada github.
    • O name não pode corresponder a uma categoria existente do GitHub Marketplace.
    • GitHub reserva os nomes de recursos GitHub.

Publicando uma ação

Você pode adicionar a ação que você criou em GitHub Marketplace identificando-a como uma nova versão e publicando-a.

Para compartilhar uma nova versão e publicar a ação em GitHub Marketplace, siga essas instruções:

  1. Em GitHub, acesse a página principal do repositório.

  2. Navegue até o arquivo de metadados da ação em seu repositório (action.yml) e você verá um banner para publicar a ação no GitHub Marketplace. Clique em Criar rascunho de uma versão.

  3. Selecione Publicar esta Ação no GitHub Marketplace em "Ação de Versão".

    Observação

    A caixa de seleção “Publish” será desabilitada se a conta que é o proprietário do repositório ainda não tiver aceitado o Contrato de Desenvolvedor do GitHub Marketplace. Se você tiver o repositório ou for um proprietário da organização, clique no link para "aceitar o Contrato de Desenvolvedor do GitHub Marketplace" e aceite o contrato. Se não houver nenhum link, envie um link para o proprietário da organização para esta página "Ação de Liberação" e solicite que ele aceite o contrato.

  4. Se os rótulos de seu arquivo de metadados tiverem algum problema, você receberá uma mensagem de erro ou uma mensagem de aviso. Resolva-os atualizando o arquivo de metadados. Após a conclusão, você verá a mensagem "Está tudo certo!" .

  5. Selecione o menu suspenso Categoria Primária e clique em uma categoria que ajudará as pessoas a encontrar sua ação no GitHub Marketplace.

  6. Opcionalmente, selecione o menu suspenso Outra Categoria e clique em uma categoria secundária.

  7. No campo de tag, digite uma versão para a ação. Isso ajuda as pessoas a saber quais alterações ou recursos estão incluídos na versão. As pessoas verão a versão na página dedicada da ação GitHub Marketplace.

  8. No campo de título, digite um título de versão.

  9. Preencha todos os outros campos e clique em Publicar versão. A publicação exige a utilização de uma autenticação de dois fatores. Para saber mais, confira Configurar a autenticação de dois fatores.

Remover uma ação de GitHub Marketplace

Para remover uma ação publicada de GitHub Marketplace, você deverá atualizar cada versão publicada. Realize as etapas a seguir para cada versão da ação que você publicou em GitHub Marketplace.

  1. Em GitHub, acesse a página principal do repositório.

  2. À direita da lista de arquivos, clique em Versões.

    Captura de tela da página principal de um repositório. Um link, rotulado como "Versões", é realçado com um contorno laranja.

  3. Ao lado da versão que você deseja editar, clique em .

    Captura de tela de uma versão na lista de versões. Um ícone de lápis é realçado com um contorno laranja.

  4. Selecione Publicar esta ação no GitHub Marketplace para remover a seleção da caixa.

  5. Clique em Atualizar versão na parte inferior da página.

Transferência de um repositório de ações

É possível transferir um repositório de ações para outro usuário ou organização. Para saber mais, confira Transferir um repositório.

Quando um administrador de repositório transfere um repositório de ações, o GitHub cria automaticamente um redirecionamento da URL anterior para a nova URL, o que significa que os fluxos de trabalho que usam a ação afetada não precisam ser atualizados.

As ações publicadas no GitHub Marketplace são vinculadas a um repositório por seu identificador exclusivo name, o que significa que você pode publicar novas versões de uma ação do repositório transferido na mesma listagem do GitHub Marketplace. Se um repositório de ações for excluído, a listagem do GitHub Marketplace também será excluída, e o identificador exclusivo name ficará disponível.

Observação

O selo “Verificado” visto no perfil do GitHub de uma organização é diferente do selo de criador verificado no GitHub Marketplace. Se você transferir um repositório de ações, a listagem do GitHub Marketplace perderá o selo de criador verificado, a menos que o novo proprietário também seja um criador verificado.

Sobre notificações no GitHub Marketplace

Ações com o ou com o selo de criador verificado indicam que o GitHub verificou o criador da ação como uma organização parceira. Os parceiros podem enviar um email para partnerships@github.com a fim de solicitar o selo de criador verificado.

Captura de tela do GitHub Actions com o selo de criador verificado.