Raghav-B / action-move-issues-to-column-projectsV2

Automate GitHub Project V2 cards on issues event

Move Issues to Project Column

This is a GitHub Actions that automatically move Issues within Project Columns based on issue or pull request events.

This action allows you to use any of the issue webhook events to create project cards. For example when an issue is opened create a card in the project column. Or on pull_request close event move all linked issues(note you should link issues in the Development section of PR) to this PR or child PRs to specific project column.

Issues workflow example

name: Move new issues into Project Boards
on:
  issues:
    types: [ opened ]
jobs:
  move-issue-to-repository-project-column:
    name: Move issues to repository project column
    runs-on: ubuntu-latest
    steps:
      - name: Move issue to 'To do' column if body has a mark 'issue:todo'
        uses: fojia/action-move-issues-to-column@master
        with:
          project: 'Actions Project'
          column: 'To do'
          owner: 'fojia'
          repo: 'action-move-issues-to-column'
          type: 'repo'
          github_token: ${{ secrets.GITHUB_TOKEN }}
          marker: 'issue:todo'
  move-issue-to-organization-project-column:
    name: Move issues to organization project column
    runs-on: ubuntu-latest
    steps:
      - name: Move issue to 'To do' column if body has a mark 'issue:todo'
        uses: fojia/action-move-issues-to-column@master
        with:
          project: 'Organization Project'
          column: 'To do'
          owner: 'fojia'
          type: 'org'
          github_token: ${{ secrets.GA_ACCESS_TOKEN}}
          marker: 'issue:todo'
  move-issue-to-user-project-column:
    name: Move issues to user project column
    runs-on: ubuntu-latest
    steps:
      - name: Move issue to 'To do' column if body has a mark 'issue:todo'
        uses: fojia/action-move-issues-to-column@master
        with:
          project: 'User Project'
          column: 'To do'
          owner: 'fojia'
          type: 'user'
          github_token: ${{ secrets.GA_ACCESS_TOKEN}}
          marker: 'issue:todo'

PR workflow example

name: Move new issues into Project Board Column
on:
  pull_request:
    types: [ closed ]
jobs:
  move-issue-to-repository-project-column-on-pull-request:
    name: Move issues to repository project column
    runs-on: ubuntu-latest
    steps:
      - name: Move all issues related to current PR(into main branch) and child PRs to 'Done' column
        uses: fojia/action-move-issues-to-column@master
        with:
          project: 'Actions Project'
          column: 'Done'
          owner: 'fojia'
          repo: 'action-move-issues-to-column'
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: main

Workflow options

Inputs	Description	Values
on	When the automation is ran	issues, push:pull_request
types	The types of event that will trigger a workflow run.	opened, edited, closed
project	The name of the project	Action Project
column	The column to create the card to	To do
github_token	The personal access token	${{ secrets.GITHUB_TOKEN }}
owner	The Project owner	fojia
repo	The Project repository (if project inside repository)	action-move-issues-to-column
type	Type for project repository, user or organization project. Default repo	repo, user, org
branch	Base branch. All issues related this PR and child PR issues will moved to the specific project column.	main

Personal access token

Most of the time GITHUB_TOKEN will work without problem. But if this not public project and repository you need to set a personal access token. Follow the instructions below to create access token.

1. Create a personal access token

   1. Public repository and repository project
   2. Private repository or private project
   3. Organisation project board or organisation repository

2. Add a secret GA_ACCESS_TOKEN with the personal access token.

3. Update the github_token in the workflow .yml to reference your new token name:

github_token: ${{ secrets.GA_ACCESS_TOKEN }}