이슈에 레이블 추가하기

GitHub Actions를 사용해서 이슈에 자동으로 레이블을 달 수 있어요. 이 튜토리얼에서는 새로 열리거나 다시 열린 이슈에 레이블을 자동으로 추가하는 방법을 알려드릴게요.

출처: 문서

본문

Introduction

이 튜토리얼에서는 워크플로우에서 GitHub CLI를 사용해서 새로 열리거나 다시 열린 이슈에 레이블을 다는 방법을 보여드릴게요. 예를 들어 이슈가 열리거나 다시 열릴 때마다 triage 레이블을 추가할 수 있어요. 그러면 triage 레이블이 달린 이슈를 필터링해서 트리아지가 필요한 모든 이슈를 확인할 수 있답니다.

GitHub CLI를 사용하면 워크플로우에서 GitHub API를 쉽게 사용할 수 있어요.

이 튜토리얼에서는 먼저 GitHub CLI를 사용하는 워크플로우 파일을 만들고, 그다음 필요에 맞게 워크플로우를 커스터마이즈할 거예요.

Creating the workflow

이 프로젝트 관리 워크플로우를 적용할 저장소를 선택하세요. 쓰기 권한이 있는 기존 저장소를 사용할 수도 있고, 새 저장소를 만들 수도 있어요. 새 저장소를 만드는 방법에 대한 자세한 내용은 Creating a new repository 문서를 참고하세요.
저장소에서 .github/workflows/YOUR_WORKFLOW.yml이라는 파일을 만드세요. YOUR_WORKFLOW를 원하는 이름으로 바꾸면 돼요. 이 파일이 바로 워크플로우 파일이에요. GitHub에서 새 파일을 만드는 방법에 대한 자세한 내용은 Creating new files 문서를 참고하세요.

다음 YAML 내용을 워크플로우 파일에 복사하세요.

name: Label issues
on:
  issues:
    types:
      - reopened
      - opened
jobs:
  label_issues:
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
      - run: gh issue edit "$NUMBER" --add-label "$LABELS"
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GH_REPO: ${{ github.repository }}
          NUMBER: ${{ github.event.issue.number }}
          LABELS: triage

워크플로우 파일에서 env 값을 커스터마이즈하세요:
- GH_TOKEN, GH_REPO, NUMBER 값은 github 및 secrets 컨텍스트를 사용해서 자동으로 설정돼요. 이 값들은 변경할 필요가 없어요.
- 이슈에 추가하려는 레이블 목록으로 LABELS 값을 변경하세요. 레이블은 저장소에 반드시 존재해야 해요. 여러 레이블은 쉼표로 구분하세요. 예를 들어 help wanted,good first issue처럼요. 레이블에 대한 자세한 내용은 Managing labels 문서를 참고하세요.
워크플로우 파일을 저장소의 기본 브랜치에 커밋하세요. 자세한 내용은 Creating new files 문서를 참고하세요.

Testing the workflow

저장소에서 이슈가 열리거나 다시 열릴 때마다 이 워크플로우가 지정한 레이블을 이슈에 추가해요.

저장소에서 이슈를 만들어 워크플로우를 테스트해 보세요.

저장소에서 이슈를 만드세요. 자세한 내용은 Creating an issue 문서를 참고하세요.
이슈를 만들면서 트리거된 워크플로우 실행을 보려면 워크플로우 실행 기록을 확인하세요. 자세한 내용은 Viewing workflow run history 문서를 참고하세요.
워크플로우가 완료되면 만든 이슈에 지정된 레이블이 추가되어 있어요.

Next steps

GitHub CLI로 할 수 있는 다른 작업에 대해 더 알아보려면 GitHub CLI manual을 참고하세요.
워크플로우를 트리거할 수 있는 다양한 이벤트에 대해 더 알아보려면 Events that trigger workflows 문서를 참고하세요.
gh issue edit을 사용하는 워크플로우 예시를 보려면 GitHub에서 검색해 보세요.

이슈에 레이블 추가하기