<div id="readability-page-1" class="page"><div><div><nav aria-label="breadcrumb"><ol itemscope="" itemtype="http://schema.org/BreadcrumbList"><li itemprop="itemListElement" itemscope="" itemtype="http://schema.org/ListItem"><a itemtype="http://schema.org/Thing" itemprop="item" href="/ko/">Home</a><meta itemprop="position" content="1"></li><li itemprop="itemListElement" itemscope="" itemtype="http://schema.org/ListItem"><a itemtype="http://schema.org/Thing" itemprop="item" href="/ko/share">share</a><meta itemprop="position" content="2"></li><li aria-current="page" itemprop="itemListElement" itemscope="" itemtype="http://schema.org/ListItem"><a itemtype="http://schema.org/Thing" itemprop="item" href="/ko/share/github-actions/set-reviewers/">[GitHub Actions] Reviewers 자동 설정</a><meta itemprop="position" content="3"></li></ol></nav></div><div><article><div id="contents_list"><h2 id="section">목차</h2><ul><li><a href="#%EA%B0%9C%EC%9A%94">개요</a></li><li><a href="#github-actions">GitHub Actions</a></li><li><a href="#dependabot%EC%9A%A9-github-actions">Dependabot용 GitHub Actions</a></li><li><a href="#actionsgithub-script">actions/github-script</a></li><li><a href="#%EC%99%84%EB%A3%8C">완료</a></li></ul></div><h2 id="개요">개요</h2><code>GitHub</code>에서 <code>Pull request</code>를 생성할 때, 다음과 같이 <code>Reviewers</code>에 수동으로 리뷰어를 설정하고 있었습니다.<picture><source srcset="/assets/images/category/share/2024/set-reviewers/pull_request_reviewers.avif" type="image/avif"><source srcset="/assets/images/category/share/2024/set-reviewers/pull_request_reviewers.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/share/2024/set-reviewers/pull_request_reviewers.png" alt="GitHub Actions - Set reviewers"></picture>이번 블로그 포스트에서는 <code>GitHub Actions</code>를 사용하여 <code>Pull request</code>의 <code>Reviewers</code>에 리뷰어를 자동으로 설정하는 방법에 대해서 알아보겠습니다.<h2 id="github-actions">GitHub Actions</h2><code>Pull request</code>의 <code>Reviewers</code>에 리뷰어를 자동으로 설정하려면 <code>.github/workflows/set_reviewers.yml</code> 파일을 생성하고 다음과 같이 수정합니다.<div><pre><code>name: Set reviewers

on:
 pull_request:

jobs:
 set-reviewers:
 name: Set reviewers
 runs-on: ubuntu-latest
 timeout-minutes: 1
 steps:
 - name: Set reviewers
 run: |
 actor="$"
 reviewers=("USER_1" "USER_2" "USER_3")

 reviewers=($(printf "%s\n" "${reviewers[@]}" | grep -v "$actor" | shuf -n 2))
 reviewers=$(printf '%s\n' "${reviewers[@]}" | jq -R . | jq -s .)

 curl -X POST \
 -H "Content-Type: application/json" \
 -H "Authorization: token $" \
 -d "{ \"reviewers\": $reviewers }" \
 "https://api.github.com/repos/$/pulls/$/requested_reviewers"
</code></pre></div>이 <code>GitHub Actions</code>는 <code>USER_1</code>, <code>USER_2</code>, <code>USER_3</code> 중에서 <code>Pull request</code>를 생성한 사람을 제외하고 랜덤으로 2명을 <code>Reviewers</code>로 설정하도록 만들었습니다.<div><pre><code>actor="$"
reviewers=("USER_1" "USER_2" "USER_3")

reviewers=($(printf "%s\n" "${reviewers[@]}" | grep -v "$actor" | shuf -n 2))
</code></pre></div><code>Pull request</code>의 리뷰어에는 기본적으로 <code>Pull request</code>를 생성한 사람은 설정할 수 없습니다.이 <code>GitHub Actions</code>를 사용하면 <code>Pull request</code>를 생성할 때마다 랜덤으로 리뷰어를 설정하여 리뷰어를 고르는 시간을 줄일 수 있습니다.<h2 id="dependabot용-github-actions">Dependabot용 GitHub Actions</h2>앞서 만든 <code>GitHub Actions</code>은 <code>Dependabot</code>이 만든 <code>Pull request</code>에서는 동작하지 않습니다. 이 <code>GitHub Actions</code>를 <code>Dependabot</code>에서도 동작하도록 만들기 위해서는 <code>pull_request</code> 부분을 <code>pull_request_target</code>으로 수정할 필요가 있습니다. <code>.github/workflows/set_reviewers.yml</code> 파일을 열고 다음과 같이 수정합니다.<div><pre><code>name: Set reviewers

on:
 pull_request_target:

jobs:
 set-reviewers:
 name: Set reviewers
 runs-on: ubuntu-latest
 timeout-minutes: 1
 steps:
 - name: Set reviewers
 run: |
 actor="$"
 reviewers=("USER_1" "USER_2" "USER_3")

 reviewers=($(printf "%s\n" "${reviewers[@]}" | grep -v "$actor" | shuf -n 2))
 reviewers=$(printf '%s\n' "${reviewers[@]}" | jq -R . | jq -s .)

 curl -X POST \
 -H "Content-Type: application/json" \
 -H "Authorization: token $" \
 -d "{ \"reviewers\": $reviewers }" \
 "https://api.github.com/repos/$/pulls/$/requested_reviewers"
</code></pre></div><code>Dependabot</code>이 만든 <code>Pull request</code>에서는 보안상에 이유로 그 어떤 <code>secrets</code>도 사용할 수 없으며, <code>Readonly</code> 동작만 가능하기 때문에 에러가 발생합니다.<ul><li><a href="https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/" rel="nofollow noreferrer" target="\_blank">GitHub Actions: Workflows triggered by Dependabot PRs will run with read-only permissions</a></li><li><a href="https://securitylab.github.com/research/github-actions-preventing-pwn-requests/" rel="nofollow noreferrer" target="\_blank">Keeping your GitHub Actions and workflows secure Part 1: Preventing pwn requests</a></li></ul>이를 수정하기 위해서는 <code>on</code>에 <code>pull_request</code> 대신 <code>pull_request_target</code>을 사용하도록 수정해야 합니다.<h2 id="actionsgithub-script">actions/github-script</h2><code>GitHub</code>에서 제공하는 <code>actions/github-script</code>를 사용하면 좀 더 읽기 쉬운 코드를 작성할 수 있습니다.<ul><li><a href="https://github.com/actions/github-script" rel="nofollow noreferrer" target="\_blank">actions/github-script</a></li></ul><code>actions/github-script</code>를 사용하면 다음과 같이 수정할 수 있습니다.<div><pre><code>name: Set reviewers

on:
 pull_request_target:

jobs:
 set-reviewers:
 name: Set reviewers
 runs-on: ubuntu-latest
 timeout-minutes: 1
 steps:
 - name: Set reviewers
 uses: actions/github-script@v5
 with:
 github-token: $
 script: |
 const reviewers = ["USER_1", "USER_2", "USER_3"];
 const actor = context.payload.pull_request.user.login;
 const { owner, repo } = context.repo;
 const prNumber = context.payload.pull_request.number;

 const { data: assignedReviewers } = await github.rest.pulls.listRequestedReviewers({
 owner,
 repo,
 pull_number: prNumber,
 });

 if (assignedReviewers.length === 0) {
 const filteredReviewers = reviewers.filter(reviewer =&gt; reviewer !== actor);
 const selectedReviewers = filteredReviewers.sort(() =&gt; Math.random() - 0.5).slice(0, 2);

 const prNumber = context.payload.pull_request.number;
 await github.rest.pulls.requestReviewers({
 owner,
 repo,
 pull_number: prNumber,
 reviewers: selectedReviewers
 });
 }
</code></pre></div><h2 id="완료">완료</h2>이것으로 <code>Pull request</code>의 <code>Reviewers</code>를 자동으로 설정하는 <code>GitHub Actions</code>를 만들어보았습니다. 이 <code>GitHub Actions</code>를 사용하면 <code>Pull request</code>에 <code>Reviewers</code>를 설정하는 시간을 줄일 수 있고, 특정 사용자에게 리뷰 요청이 집중되는 것을 막을 수 있습니다.<code> 제 블로그가 도움이 되셨나요? 하단의 댓글을 달아주시면 저에게 큰 힘이 됩니다! </code><h2>앱 홍보</h2><div> 지금 보고 계신 블로그를 작성하는 <code>Deku</code>가 개발한 앱을 한번 사용해보세요. <code>Deku</code>가 개발한 앱은 Flutter로 개발되었습니다. 관심있으신 분들은 앱을 다운로드하여 사용해 주시면 정말 감사하겠습니다.</div><h2>책 홍보</h2></article></div></div></div>

dev-yakuza

GitHub Actions를 사용하여 Pull request의 Reviewers에 리뷰어를 자동으로 설정하는 방법에 대해서 알아보겠습니다.