레이블이 추가될 때 이슈에 주석 달기

GitHub Actions을(를) 사용하여 특정 레이블이 적용될 때 발생하는 이슈에 자동으로 주석을 달 수 있습니다.

이 문서의 내용

소개

이 자습서에서는 GitHub CLI을(를) 사용하여 특정 레이블이 적용될 때 이슈에 주석을 다는 방법을 보여줍니다. 예를 들어 help wanted 레이블이 이슈에 추가될 때 주석을 추가하여 기여자에게 이슈 관련 작업을 권장할 수 있습니다. GitHub CLI에 대한 자세한 내용은 워크플로에서 GitHub CLI 사용을(를) 참조하세요.

자습서에서는 먼저 gh issue comment 명령을 사용하여 이슈에 대해 주석을 다는 워크플로 파일을 만듭니다. 그런 다음 필요에 맞게 워크플로를 사용자 지정합니다.

워크플로 만들기

  1. 이 프로젝트 관리 워크플로를 적용할 리포지토리를 선택합니다. 쓰기 권한이 있는 기존 리포지토리를 사용하거나 새 리포지토리를 만들 수 있습니다. 리포지토리를 만드는 자세한 내용은 “새 리포지토리 만들기”를 참조하세요.

  2. 리포지토리에서 YOUR_WORKFLOW를 선택한 이름으로 바꾸는 .github/workflows/YOUR_WORKFLOW.yml 파일을 만듭니다. 워크플로 파일입니다. GitHub에서 새 파일을 만드는 방법에 대한 자세한 내용은 “새 파일 만들기”를 참조하세요.

  3. 다음 YAML 콘텐츠를 워크플로 파일에 복사합니다.

    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:

  4. 워크플로 파일에서 매개 변수를 사용자 지정합니다.

    • 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에 대한 자세한 내용은 기본 쓰기 및 서식 지정 구문을(를) 참조하세요.

  5. 워크플로 파일을 리포지토리의 기본 분기에 커밋합니다. 자세한 내용은 "새 파일 만들기"을(를) 참조하세요.

워크플로 테스트

리포지토리의 이슈에 레이블이 지정될 때마다 이 워크플로가 실행됩니다. 추가된 레이블이 워크플로 파일에서 지정한 레이블 중 하나인 경우 gh issue comment 명령은 지정된 주석을 이슈에 추가합니다.

지정된 레이블을 이슈에 적용하여 워크플로를 테스트합니다.

  1. 리포지토리에서 이슈를 엽니다. 자세한 내용은 문제 만들기을(를) 참조하세요.
  2. 워크플로 파일에서 지정된 레이블을 사용하여 이슈에 레이블을 지정합니다. 자세한 내용은 레이블 관리을(를) 참조하세요.
  3. 이슈에 레이블을 지정하여 트리거된 워크플로 실행을 확인하려면 워크플로 실행 기록을 살펴봅니다. 자세한 내용은 워크플로 실행 기록 보기을(를) 참조하세요.
  4. 워크플로가 완료될 때 레이블을 지정한 이슈에 주석이 추가되어 있어야 합니다.

다음 단계

  • GitHub CLI로 수행할 수 있는 추가 작업(예: 기존 주석 편집)에 대한 자세한 내용은 GitHub CLI 설명서를 참조하세요.