Skip to main content

Moving assigned issues on project boards

You can use GitHub Actions to automatically move an issue to a specific column on a project board when the issue is assigned.

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.

Introduction

This tutorial demonstrates how to use the alex-page/github-project-automation-plus action to automatically move an issue to a specific column on a project board when the issue is assigned. For example, when an issue is assigned, you can move it into the In Progress column your project board.

In the tutorial, you will first make a workflow file that uses the alex-page/github-project-automation-plus action. Then, you will customize the workflow to suit your needs.

Creating the workflow

  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. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "Creating a project board."

  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. Copy the following YAML contents into your workflow file.

    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: Move assigned card
    on:
      issues:
        types:
          - assigned
    jobs:
      move-assigned-card:
        runs-on: ubuntu-latest
        steps:
          - uses: alex-page/github-project-automation-plus@5bcba1c1c091a222584d10913e5c060d32c44044
            with:
              project: Docs Work
              column: In Progress
              repo-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
  5. Customize the parameters in your workflow file:

    • Change the value for project to the name of your project board. If you have multiple project boards with the same name, the alex-page/github-project-automation-plus action will act on all projects with the specified name.
    • Change the value for column to the name of the column where you want issues to move when they are assigned.
    • Change the value for repo-token:
      1. Create a personal access token with the repo scope. For more information, see "Creating a personal access token."
      2. Store this personal access token as a secret in your repository. For more information about storing secrets, see "Encrypted secrets."
      3. In your workflow file, replace PERSONAL_ACCESS_TOKEN with the name of your secret.
  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".

Testing the workflow

Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board.

If your repository is user-owned, the alex-page/github-project-automation-plus action will act on all projects in your repository or personal account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column.

Test your workflow by assigning an issue in your repository.

  1. Open an issue in your repository. For more information, see "Creating an issue."
  2. Assign the issue. For more information, see "Assigning issues and pull requests to other GitHub users."
  3. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "Viewing workflow run history."
  4. When the workflow completes, the issue that you assigned should be added to the specified project board column.

Next steps