Home

Awesome

Auto card labeler

CI Status codecov CodeFactor License: MIT

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

<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <details> <summary>Details</summary> </details> <!-- END doctoc generated TOC please keep comment here to allow auto update -->

Screenshot

GitHub Action

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

namedescriptiondefaultrequirede.g.
CONFIG_FILENAMEConfig file namecard-labeler.ymltruecard-labeler-setting.yml
GITHUB_TOKENAccess token${{github.token}}true${{secrets.ACCESS_TOKEN}}

Action event details

Target event

eventNameaction
project_cardmoved
project_cardcreated

Author

GitHub (Technote)
Blog