[Github Actions]모노레포에서 PR 생성 시 레포 별 오토 라벨링

💽 모노레포란?

여러 개의 프로젝트 또는 패키지를 하나의 저장소 안에서 관리하는 방식을 말한다.

각각의 서비스나 라이브러리를 따로따로 Git 저장소를 만들어서 관리하는 방식은 멀티레포(multi-repo)라고 하고, 반대로 한 저장소 안에 모든 관련 프로젝트를 함께 넣어두고 버전, 빌드, 배포를 함께 관리하는 구조가 모노레포(mono-repo)이다.

🏷️ PR 생성 시 오토 라벨링을 적용하려는 이유

하나의 모노레포에는 여러가지 패키지/서비스가 공존하기 때문에, PR 생성 시 어느 패키지에 영향을 주는지 확인하고 싶었다.

물론 PR 생성자가 직접 작업 범위에 따라 라벨을 추가 해줄 수 있지만, 모노레포의 크기가 커질수록 번거롭고 실수할 가능성이 커진다.

🤖 오토 라벨링 적용 방법

https://github.com/actions/labeler/tree/v2.0.0

actions/labeler (v2.0.0)는 Pull Request(PR)에서 변경된 파일 경로를 기반으로 자동으로 라벨을 추가해주는 GitHub Actions이다.

프로젝트의 구조가 아래와 같을 때

apps/
  web/        # 웹 프론트엔드
  mobile/     # 모바일 앱
packages/
  ui/         # 공통 UI 컴포넌트
  utils/      # 공통 유틸리티

.github/labeler.yml 파일 생성 후 아래 코드를 추가한다.

#.github/labeler.yml
partner:
  - apps/web/**

user:
  - apps/mobile/**

.github/labeler.yml에 라벨 이름과 그 라벨을 적용할 파일 경로 패턴(minimatch glob) 목록을 작성하면, PR 생성 시 GitHub Actions가 해당 PR에서 변경된 파일 목록을 확인한다.

#.github/workflows/pr-label.yaml
name: Auto Label PR by Path

on:
  pull_request:
    types: [opened, synchronize, reopened]

permissions:
  contents: read
  pull-requests: write

jobs:
  label:
    runs-on: ubuntu-latest

    steps:
      - name: Run labeler
        uses: actions/labeler@v2
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

이 Github Actions는 PR이 생성/수정/재오픈될 때마다 라벨링 작업을 수행한다.

• opened: 새로운 Pull Request가 생성되었을 때 실행
• synchronize: 기존 PR에 새로운 커밋이 추가되었을 때 실행
• reopened: 닫힌 PR을 다시 열었을 때 실행

permissions:
  contents: read
  pull-requests: write

이 때 위와 같은 권한 추가가 필요하다.

• contents: read → 레포지토리 파일을 읽을 수 있음
• pull-requests: write → PR에 라벨을 붙이거나 수정할 수 있는 권한을 부여

steps:
  - name: Run labeler
    uses: actions/labeler@v2
    with:
      repo-token: ${{ secrets.GITHUB_TOKEN }}

• steps: job 안에서 실행할 명령 단계 목록
• uses: actions/labeler@v2: GitHub Actions 마켓플레이스에서 제공하는 labeler 액션 v2를 사용
• with: 액션에 입력값(arguments)을 전달하는 부분
• repo-token: ${{ secrets.GITHUB_TOKEN }} (GitHub가 자동으로 제공하는 레포 전용 토큰을 사용) → 이 토큰 덕분에 PR에 라벨을 붙일 수 있음 (권한: pull-requests: write)

PR 이벤트 발생 시 .github/labeler.yml에서 설정한 경로의 변경사항이 생일 때 자동으로 라벨을 생성해준다.