GitHub Action
PR Buddy
v1.1
Latest version
GitHub Actions를 활용하여 PR 리뷰어와 담당자를 자동으로 지정할 수 있습니다.
GitHub Actions Workflow Template
# .github/workflows/{workflow_name}.yml
name: Assign PR Reviewer & Assignee
on:
pull_request:
branches:
- develop
- pjt-01-develop
types: [ opened, ready_for_review ]
jobs:
auto-assign:
runs-on: ubuntu-latest
# GITHUB_TOKEN 또는 PERSONAL_ACCESS_TOKEN 모두
# content:read, pull-requests:write 권한이 반드시 필요합니다.
permissions:
contents: read
pull-requests: write
steps:
- name: Assign PR Reviewer & Assignee
uses: SeongHo5/pr-buddy@{target_version}
with:
config: .github/auto-assign.yml # 경로를 정확하게 지정해주세요.(파일명이 반드시 동일할 필요는 없어요.)
Configuration Template
# .github/auto-assign.yml
# ===== Reviwers 관련 설정 =====
# 리뷰어 자동 지정 활성화 여부
enableAutoAssignReviewers: boolean
# Reviewer로 지정할 인원 수
# 지정한 인원 수 만큼 후보 목록에서 랜덤으로 선택합니다.
# 0인 경우 reviewers 목록 또는 reviewersGroups 목록에서 전체 인원을 지정합니다.
numberOfReviewers: number
# Reviewer로 지정될 수 있는 후보 목록
reviewers: string[]
# ===== Assignees 관련 설정 =====
# 담당자 자동 지정 활성화 여부 / boolean 또는 'author'만 가능
# 'author'로 설정 시 PR 작성자를 담당자로 지정합니다.
enableAutoAssignAssignees: boolean | string
# Assignee로 지정될 수 있는 후보 목록 (Optional)
# enableAutoAssignAssignees가 'author'로 설정된 경우 작성할 필요 없음
numberOfAssignees: number
# Assignee로 지정될 수 있는 후보 목록 (Optional)
# enableAutoAssignAssignees가 'author'로 설정된 경우 작성할 필요 없음
assignees: string[]
# ===== 기타 =====
# Auto-Assign에서 제외할 키워드 목록
# 이 키워드가 PR 제목에 포함되어 있으면 Auto-Assign이 적용되지 않습니다.
ignoreKeywords: string[]
# Draft PR에도 Auto-Assign을 적용할지 여부
runOnDraft: boolean