레이블이 추가되면 이슈에 댓글 달기

GitHub Actions를 사용해서 특정 레이블이 적용될 때 이슈에 자동으로 댓글을 달 수 있어요. 이 튜토리얼에서는 특정 레이블이 적용될 때 이슈에 댓글을 다는 방법을 알려드릴게요.

출처: 문서

본문

Introduction

이 튜토리얼에서는 특정 레이블이 적용될 때 GitHub CLI를 사용해서 이슈에 댓글을 다는 방법을 보여드릴게요. 예를 들어 이슈에 help wanted 레이블이 추가되면 기여자들이 이슈를 처리하도록 장려하는 댓글을 추가할 수 있어요. GitHub CLI에 대한 자세한 내용은 Using GitHub CLI in workflows 문서를 참고하세요.

이 튜토리얼에서는 먼저 gh issue comment 명령을 사용해서 이슈에 댓글을 다는 워크플로우 파일을 만들고, 그다음 필요에 맞게 워크플로우를 커스터마이즈할 거예요.

Creating the workflow

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

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

name: Add comment
on:
  issues:
    types:
      - labeled
jobs:
  add-comment:
    if: github.event.label.name == 'help wanted'
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
      - name: Add comment
        run: gh issue comment "$NUMBER" --body "$BODY"
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GH_REPO: ${{ github.repository }}
          NUMBER: ${{ github.event.issue.number }}
          BODY: >
            This issue is available for anyone to work on.
            **Make sure to reference this issue in your pull request.**
            :sparkles: Thank you for your contribution! :sparkles:

워크플로우 파일에서 매개변수를 커스터마이즈하세요:
- if: github.event.label.name == 'help wanted'의 help wanted를 처리하려는 레이블로 바꾸세요. 둘 이상의 레이블을 처리하려면 조건을 ||로 구분하세요. 예를 들어 if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'는 이슈에 bug 또는 fix me 레이블이 추가될 때마다 댓글을 달아요.
- 추가하려는 댓글로 BODY 값을 변경하세요. GitHub flavored markdown이 지원돼요. markdown에 대한 자세한 내용은 Basic writing and formatting syntax 문서를 참고하세요.
워크플로우 파일을 저장소의 기본 브랜치에 커밋하세요. 자세한 내용은 Creating new files 문서를 참고하세요.

Testing the workflow

저장소에서 이슈에 레이블이 지정될 때마다 이 워크플로우가 실행돼요. 추가된 레이블이 워크플로우 파일에서 지정한 레이블 중 하나라면 gh issue comment 명령이 지정한 댓글을 이슈에 추가해요.

지정한 레이블을 이슈에 적용해서 워크플로우를 테스트해 보세요.

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

Next steps

기존 댓글 편집처럼 GitHub CLI로 할 수 있는 다른 작업에 대해 더 알아보려면 GitHub CLI Manual을 방문하세요.

레이블이 추가되면 이슈에 댓글 달기