Skip to main content

Remover uma etiqueta quando um cartão é adicionado à coluna de um quadro de projeto

Você pode usar GitHub Actions para remover automaticamente uma etiqueta quando um problema ou pull request for adicionado a uma coluna específica no quadro de um projeto.

Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Introdução

Este tutorial demonstra como usar a ação andymckay/labeler com um condicional para remover um rótulo de solicitações de pull e problemas que são adicionados a uma coluna específica em um quadro de projetos. Por exemplo, você pode remover o rótulo needs review quando os cartões de projeto são movidos para a coluna Done.

No tutorial, primeiro, você criará um arquivo de fluxo de trabalho que usa a ação andymckay/labeler. Então, você personalizará o fluxo de trabalho para atender às suas necessidades.

Criar o fluxo de trabalho

  1. Escolha um repositório onde você deseja aplicar este fluxo de trabalho de gerenciamento de projetos. Você pode usar um repositório existente ao qual você tem acesso de gravação ou criar um novo repositório. Para obter mais informações sobre como criar um repositório, confira "Como criar um repositório".

  2. Escolha um projeto que pertence ao repositório. Este fluxo de trabalho não pode ser usado com projetos que pertencem a usuários ou organizações. Você pode usar um projeto existente ou criar um novo projeto. Para obter mais informações sobre como criar um projeto, confira "Como criar um quadro de projetos".

  3. No repositório, crie um arquivo chamado .github/workflows/YOUR_WORKFLOW.yml, substituindo YOUR_WORKFLOW por um nome de sua escolha. Este é um arquivo do fluxo de trabaho. Para obter mais informações sobre como criar arquivos no GitHub, confira "Como criar arquivos".

  4. Copie o seguinte conteúdo YAML para o arquivo do fluxo de trabalho.

    YAML
    # Esse fluxo de trabalho usa ações que não são certificadas pelo GitHub.
    # São fornecidas por terceiros e regidas por
    # termos de serviço, política de privacidade e suporte separados
    # online.
    
    # O GitHub recomenda fixar ações em um SHA de commit.
    # Para obter uma versão mais recente, você precisará atualizar o SHA.
    # Você também pode fazer referência a uma marca ou branch, mas a ação pode ser alterada sem aviso.
    
    name: Remove labels
    on:
      project_card:
        types:
          - moved
    jobs:
      remove_labels:
        if: github.event.project_card.column_id == '12345678'
        runs-on: ubuntu-latest
        permissions:
          issues: write
          pull-requests: write
        steps:
          - name: remove labels
            uses: andymckay/labeler@5c59dabdfd4dd5bd9c6e6d255b01b9d764af4414
            with:
              remove-labels: "needs review"
              repo-token: ${{ secrets.GITHUB_TOKEN }}
  5. Personalize os parâmetros no seu arquivo do fluxo de trabalho:

    • Em github.event.project_card.column_id == '12345678', substitua 12345678 pela ID da coluna em que deseja remover o rótulo de solicitações de pull e problemas que são movidos para ela.

      Para encontrar o ID da coluna, acesse o seu quadro de projetos. Ao lado do título da coluna, clique em e clique em Copiar link da coluna. O ID da coluna é o número no final do link copiado. Por exemplo, 24687531 é a ID da coluna para https://github.com/octocat/octo-repo/projects/1#column-24687531.

      Caso deseje modificar mais de uma coluna, separe as condições com ||. Por exemplo, if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321' funcionará sempre que um cartão de projeto for adicionado à coluna 12345678 ou à coluna 87654321. As colunas podem estar em diferentes quadros de projetos.

    • Altere o valor de remove-labels para a lista de rótulos que deseja remover de problemas ou solicitações de pull que são movidos para as colunas especificadas. Separe etiquetas múltiplas com vírgulas. Por exemplo, "help wanted, good first issue". Para obter mais informações sobre rótulos, confira "Como gerenciar rótulos".

  6. Faça o commit do arquivo de fluxo de trabalho para o branch padrão do seu repositório. Para obter mais informações, confira "Como criar arquivos".

Testar o fluxo de trabalho

Cada vez que um cartão de projeto em um projeto no seu repositório for transferido, este fluxo de trabalho será executado. Se o cartão for um problema ou uma pull request e for movido para a coluna especificada, o fluxo de trabalho removerá os rótulos especificados do problema ou de um pull request. Os cartões que são observações que não serão afetadas.

Teste o seu fluxo de trabalho transferindo um problema no seu projeto para a coluna de destino.

  1. Abra um problema no seu repositório. Para obter mais informações, confira "Como criar um problema".
  2. Etiquete o problema com as etiquetas que deseja que o fluxo de trabalho remova. Para obter mais informações, confira "Como gerenciar rótulos".
  3. Adicione um problema na coluna do projeto que você especificou no arquivo do fluxo de trabalho. Para obter mais informações, confira "Como adicionar problemas e solicitações de pull a um quadro de projetos".
  4. Para ver a execução do fluxo de trabalho que foi acionada adicionando o problema ao projeto, visualize o histórico da execução do seu fluxo de trabalho. Para obter mais informações, confira "Como ver o histórico de execução do fluxo de trabalho".
  5. Quando o fluxo de trabalho é concluído, o problema que você adicionou na coluna do projeto deve ter as etiquetas especificadas removidos.

Próximas etapas

  • Para saber mais sobre outras coisas que você pode fazer com a ação andymckay/labeler, como adicionar rótulos ou ignorar essa ação se o problema for atribuído ou tiver um rótulo específico, acesse a documentação da ação andymckay/labeler.
  • Pesquise o GitHub para ver exemplos de fluxos de trabalho que usam essa ação.