technote-space/auto-card-labeler

GitHub actions to auto label a pull request or an issue based on project card move

Auto card labeler

Read this in other languages: English, 日本語.

This is a GitHub Actions that automatically labels Issues or PullRequests based on project card moves.

Table of Contents

Details

• Screenshot
• Usage
• Behavior
• Options
• Action event details
  • Target event
• Author

Screenshot

Usage

1. Setup workflow
   e.g. .github/workflows/project-card-moved.yml

   on:
     project_card:
       types: [moved]
   name: Project Card Event
   jobs:
     triage:
       name: Auto card labeler
       runs-on: ubuntu-latest
       steps:
         - uses: technote-space/auto-card-labeler@v2

2. Add action setting
   e.g. .github/card-labeler.yml

   Project name1:
     Column name1:
       - 'Status: test1'
     Column name2:
       - 'Status: test2-1'
       - 'Status: test2-2'
   Project name2:
     Column name3:
       - 'Status: test1'

Behavior

e.g.

Project name1:
  Column name1:
    - 'Status: test1'
  Column name2:
    - 'Status: test2-1'
    - 'Status: test2-2'

1. Card created (Column name1)
   • Add
     • Status: test1
   • Remove
     • None
   • Current Labels
     • Status: test1
2. Card moved to Column name2
   • Add
     • Status: test2-1
     • Status: test2-2
   • Remove
     • Status: test1
   • Current Labels
     • Status: test2-1
     • Status: test2-2
3. Card moved to Column name3
   • Add
     • None
   • Remove
     • Status: test2-1
     • Status: test2-2
   • Current Labels
     • None
4. Card moved to Column name1
   • Add
     • Status: test1
   • Remove
     • None
   • Current Labels
     • Status: test1

Options

name	description	default	required	e.g.
CONFIG_FILENAME	Config file name	card-labeler.yml	true	card-labeler-setting.yml
GITHUB_TOKEN	Access token	${{github.token}}	true	${{secrets.ACCESS_TOKEN}}

Action event details

Target event

eventName	action
project_card	moved
project_card	created

Author

GitHub (Technote)
Blog