<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/pr-labels-checker/">[GitHub Actions] Pull request의 Label 검사</a><meta itemprop="position" content="3"></li></ol></nav></div><div><article><div id="contents_list"><h2 id="section">목차</h2><ul><li><a href="#%EB%AA%A9%EC%B0%A8">목차</a></li><li><a href="#%EA%B0%9C%EC%9A%94">개요</a></li><li><a href="#%EB%B8%94%EB%A1%9C%EA%B7%B8-%EC%8B%9C%EB%A6%AC%EC%A6%88">블로그 시리즈</a></li><li><a href="#pr-labels-checker">PR Labels Checker</a></li><li><a href="#github-actions-%EC%9E%91%EC%84%B1">GitHub Actions 작성</a></li><li><a href="#release-drafter">Release Drafter</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>Labels</code> 기능을 사용하여 <code>Pull request</code>를 관리합니다.<picture><source srcset="/assets/images/category/share/2023/github-actions/pr-labels-checker/pull_request_labels.avif" type="image/avif"><source srcset="/assets/images/category/share/2023/github-actions/pr-labels-checker/pull_request_labels.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/share/2023/github-actions/pr-labels-checker/pull_request_labels.png" alt="GitHub Actions - PR Labels Checker, pull request labels"></picture>이번 블로그 포스트에서는 <code>GitHub Actions</code>중 하나인 <code>PR Labels Checker</code>를 사용하여 <code>Pull request</code>의 <code>Labels</code>를 검사하는 방법에 대해서 알아보겠습니다.<h2 id="블로그-시리즈">블로그 시리즈</h2>이 블로그는 시리즈로 제작되었습니다. 다음 링크를 통해 다른 블로그 포스트도 확인해 보시기 바랍니다.<ul><li><a href="https://deku.posstree.com/ko/share/github-actions/pr-title-checker/" target="\_blank">[GitHub Actions] Pull request 제목 검사</a></li><li><a href="https://deku.posstree.com/ko/share/github-actions/release-drafter/" target="\_blank">[GitHub Actions] Release notes 자동화</a></li><li>[GitHub Actions] Pull request의 라벨 검사</li></ul><h2 id="pr-labels-checker">PR Labels Checker</h2><code>PR Labels Checker</code>는 <code>GitHub Actions</code>중 하나로, <code>Pull request</code>의 <code>Labels</code>를 검사하는 기능을 제공하고 있습니다.<ul><li><a href="https://github.com/danielchabr/pr-labels-checker" rel="nofollow noreferrer" target="\_blank">PR Labels Checker</a></li></ul><h2 id="github-actions-작성">GitHub Actions 작성</h2><code>PR Labels Checker</code>를 사용하여 <code>Pull request</code>의 <code>Labels</code>를 검사하는 <code>GitHub Actions</code>를 작성해 보겠습니다. <code>.github/workflows/pr-labels-checker.yml</code> 파일을 만들고 다음과 같이 수정합니다.<div><pre><code>name: PR Labels Checker

on:
 push:
 branches:
 - main
 pull_request:
 types:
 - opened
 - reopened
 - synchronize
 - labeled
 - unlabeled

jobs:
 pr_labels_checker:
 permissions:
 pull-requests: write
 checks: write
 runs-on: ubuntu-latest
 steps:
 - uses: danielchabr/<a href="/cdn-cgi/l/email-protection" data-cfemail="5c2c2e71303d3e39302f713f34393f37392e1c2a6f726d">[email&nbsp;protected]</a>
 with:
 hasSome: breaking change,feature,bug,style,refactor,test,chore,docs,ci,dependencies
 githubToken: $
</code></pre></div>이 <code>GitHub Actions</code>는 <code>Pull request</code>가 생성되거나 <code>Pull request</code>의 <code>Label</code>을 추가, 해제할 때, 실행됩니다.<div><pre><code>on:
 push:
 branches:
 - main
 pull_request:
 types:
 - opened
 - reopened
 - synchronize
 - labeled
 - unlabeled
</code></pre></div><code>PR Labels Checker</code>를 사용하기 위해서는 <code>Pull request</code>와 <code>checks</code>에 대한 권한이 필요합니다.<div><pre><code>jobs:
 pr_labels_checker:
 permissions:
 pull-requests: write
 checks: write
</code></pre></div>이제 <code>PR Labels Checker</code>를 사용하여 <code>Pull request</code>의 <code>Label</code>을 검사합니다. <code>Label</code>을 검사할 때는 다음과 같은 조건을 사용할 수 있습니다.<ul><li>hasSome: 콤마로 구분된 Label 리스트로, PR은 이 중 하나를 반드시 포함해야 합니다.</li><li>hasAll: 콤마로 구분된 Label 리스트로, PR은 이 리스트 모두 포함해야 합니다.</li><li>hasNone: 콤마로 구분된 Label 리스트로, PR은 이 리스트중 그 어떤 것도 포함해서는 안됩니다.</li><li>hasNotAll: 콤마로 구분된 Label 리스트로, PR은 이 리스트 모두를 포함해서는 안됩니다.</li></ul>이번 블로그 포스트에서는 <code>hasSome</code> 조건을 사용하였습니다.<div><pre><code>hasSome: breaking change,feature,bug,style,refactor,test,chore,docs,ci,dependencies
</code></pre></div>조건에 포함된 <code>Label</code>들은 <code>Release notes 자동화</code>하기 위해 필요한 리스트입니다. 자세한 내용은 다음 링크를 참고하시기 바랍니다.<ul><li><a href="https://deku.posstree.com/ko/share/github-actions/release-drafter/" target="\_blank">[GitHub Actions] Release notes 자동화</a></li></ul><code>PR Labels Checker</code>는 <code>GitHub Actions</code>에서 <code>Pull request</code>의 <code>Label</code>을 검사하기 위해 <code>GitHub Token</code>을 사용합니다. 따라서 다음과 같이 <code>GITHUB_TOKEN</code>을 설정해야 합니다.<h2 id="release-drafter">Release Drafter</h2>저는 <code>Release notes</code>의 자동화를 위해 <code>Release Drafter</code>를 사용하고 있습니다. <code>Release Drafter</code>는 <code>Pull request</code>의 <code>Labels</code>를 사용하여 <code>Release notes</code>를 자동으로 작성합니다. 또한, <code>Pull request</code>의 제목을 보고 자동으로 <code>Labels</code>를 설정하는 기능도 가지고 있습니다.그래서 <code>Pull request</code>의 <code>Labels</code>가 중요하며, <code>Release Drafter</code>가 자동으로 설정해 주지만, 이를 확실하게 하기 위해 <code>PR Labels Checker</code>를 사용하여 <code>Pull request</code>의 <code>Labels</code>를 다시 한번 검사하고 있습니다.이를 위한 <code>GitHub Actions</code>와 다음과 같습니다.<div><pre><code>name: Release Drafter

on:
 push:
 branches:
 - main
 pull_request:
 types:
 - opened
 - reopened
 - synchronize

permissions:
 contents: read

jobs:
 update_release_draft:
 permissions:
 contents: write
 pull-requests: write
 checks: write
 runs-on: ubuntu-latest
 steps:
 - uses: release-drafter/release-drafter@v5
 env:
 GITHUB_TOKEN: $
 - uses: danielchabr/<a href="/cdn-cgi/l/email-protection" data-cfemail="e9999bc485888b8c859ac48a818c8a828c9ba99fdac7d8">[email&nbsp;protected]</a>
 with:
 hasSome: breaking change,feature,bug,style,refactor,test,chore,docs,ci,dependencies
 githubToken: $
</code></pre></div><code>Release Drafter</code>를 사용하여 <code>Pull request</code>에 자동으로 <code>Labels</code>를 설정하고, 자동으로 설정된 <code>Pull request</code>의 <code>Labels</code>를 <code>PR Labels Checker</code>를 사용하여 다시 한번 검사하도록 했습니다.<code>Release Drafter</code>에 관한 자세한 내용은 다음 링크를 참고하시기 바랍니다.<ul><li><a href="https://deku.posstree.com/ko/share/github-actions/release-drafter/" target="\_blank">[GitHub Actions] Release notes 자동화</a></li></ul><h2 id="완료">완료</h2>이것으로 <code>GitHub Actions</code>의 <code>PR Labels Checker</code>를 사용하여 <code>Pull request</code>의 <code>Labels</code>를 검사하는 방법에 대해서 알아보았습니다.<code>Pull request</code>를 <code>Labels</code>를 사용하여 관리하는 경우나, 저처럼 <code>Release notes</code>를 자동화하기 위해 <code>Release Drafter</code>를 사용하는 분들은 <code>PR Labels Checker</code> 도입을 고려해 보시기 바랍니다.<code> 제 블로그가 도움이 되셨나요? 하단의 댓글을 달아주시면 저에게 큰 힘이 됩니다! </code><h2>앱 홍보</h2><div> 지금 보고 계신 블로그를 작성하는 <code>Deku</code>가 개발한 앱을 한번 사용해보세요. <code>Deku</code>가 개발한 앱은 Flutter로 개발되었습니다. 관심있으신 분들은 앱을 다운로드하여 사용해 주시면 정말 감사하겠습니다.</div><h2>책 홍보</h2></article></div></div></div>

dev-yakuza

GitHub Actions중 하나인 PR Labels Checker를 사용하여 GitHub의 Pull request의 Label을 검사하는 방법에 대해서 알아보겠습니다.