[Github Actions] PR open 시 라벨 추가하고 closed 시 삭제하기

현재 상황

PR 리뷰 관련 라벨을 만들어서 리뷰 상황 및 반영 상황을 트래킹하고 있었다

 

흐름은 대략 아래와 같다

1. PR open : 리뷰 필요 라벨 추가

- 리뷰중 : 리뷰어가 리뷰 중인 경우

- 답변 필요 : 리뷰 과정 중에 질문이 생겨 PR 담당자의 답변이 필요한 경우

- 수정 요청 : request changes인 경우

- 수정 반영 중 : 요청된 수정 사항을 반영하고 있는 경우

- 머지 가능 : 리뷰어가 리뷰 완료하고 문제 없는 경우

2. PR close : 머지 가능 라벨 삭제

 

 

 

하지만 매번 PR을 올릴 때마다 라벨을 추가하는 것도 귀찮았다

그리고 가장 싫었던 것은 PR을 머지한 이후에 남는 진행과정 라벨들이었다!! 

 

 

이전 프로젝트에서 남은 수많은 라벨들...

 

지금까지는 수동으로 머지 시 해당 라벨을 제거하고 있었지만 PR 개수가 늘어남에 따라 너무나도 귀찮아졌다.

그래서 github action 스크립트 작성에 도전하게 되었다!

 

Github Action marketPlace를 이용하자

처음에는 내가 직접 작성해보려고 했으나 Curl -X 를 이용해서 삭제 및 추가 요청을 보내는 부분에서 자꾸 오류가 났다

그래서 그냥 잘 만들어놓은 다른 사람들의 코드를 사용하기로 결정했다

 

여러 유명한 Actions 들이 많았지만 다들 PR에서 무언가를 읽어서 그거에 맞게 라벨을 달아주는 action이었다!

내가 필요한 건 단순히 라벨을 달아주는 actions이었기 때문에 star가 적더라도 그냥 사용했다

 

Github Token 등록

뭐 어디에서는 자동으로 등록된다고 하는데 나는 전혀 먹히지 않았다!

그래서 걍 발급받고 개인 토큰으로 등록했다.

 

[Github Token 발급]

1. Profile - Settings - Developer Settings 진입

2. Personal Access tokens - Tokens (classic) - Generate new token(classic) (새로 뭐 나왔던데 beta라 안 썼다)

3. 여기에서 발급 받은 토큰 값을 잘 저장해준다

 

[Github Token 등록]

1. Action을 등록할 repository로 이동

2. Settings - Secrets and variables - Actions

3. New Repository secret 클릭

4. 원하는 토큰 이름 입력 후 발급받은 Github Token 입력

참고로 GITHUB_으로 시작하는 토큰은 입력할 수 없으니 알아서 다른 값을 생각해보도록 하자

 

팀 프로젝트에 내 개인 토큰 등록해놓는 거라 이름을 저렇게 지어놨다

 

 

PR open 시 특정 라벨 추가

PR이 열릴 때마다 👀리뷰필요 라벨 추가

 

https://github.com/actions-ecosystem/action-add-labels

GitHub - actions-ecosystem/action-add-labels: 🏷️ GitHub Action to add labels

 

아직 오류가 있어서 이슈를 보고 권한 추가하는 명령어를 추가했다

 

name: Add Label to PRs

on:
  pull_request:
    types:
      - opened

jobs:
  add_label:
    runs-on: ubuntu-latest

	# repository에 권한 부여
    permissions:
      contents: read
      pull-requests: write

    steps:
      - name: checkout
        uses: actions/checkout@v2

      - name: add label
        uses: actions-ecosystem/action-add-labels@v1.1.0
        with:
          github_token: ${{ secrets.PERSONAL_TOKEN }}
          labels: 👀리뷰필요

 

PR close 시 특정 라벨 제거

PR 닫힐 때 😊머지가능❓답변필요👀리뷰필요💪수정요청💻수정반영중🖌리뷰중 라벨 제거 

 

https://github.com/actions-ecosystem/action-remove-labels

GitHub - actions-ecosystem/action-remove-labels: 🏷️ GitHub Action to remove labels

 

PR에 라벨이 없는 경우에는 에러가 나서 action이 멈춘다는 이슈가 아직도 해결되지 않았다.

그래서 그냥 에러가 난 경우에도 무시하고 돌아가도록 하는 fail_on_error를 명시적으로 false로 주었다(이 action 한정)

 

권한 추가하는 명령어도 주었다

name: Remove Labels

on:
  pull_request:
    types:
      - closed

jobs:
  remove_labels:
    runs-on: ubuntu-latest

	# repository 관련 권한 추가
    permissions:
      contents: read
      pull-requests: write

    steps:
      - uses: actions/checkout@v2
      - uses: actions-ecosystem/action-remove-labels@v1.3.0
        with:
          github_token: ${{ secrets.PERSONAL_TOKEN }}
          # 에러 무시
          fail_on_error: false
          labels: |
            😊머지가능
            ❓답변필요
            👀리뷰필요
            💪수정요청
            💻수정반영중
            🖌리뷰중

 

결과

아주 잘 돌아가고 아주 편리하다!

근데 내 Github Token으로 등록해서 그런가 다른 분들 PR에도 내가 라벨을 관리하는 것처럼 떠서 조금 민망하다ㅎ..

수상하리만큼 PR이 올라오면 달려오는 여성