<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/"><span itemprop="name">Home</span></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"><span itemprop="name">share</span></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-title-checker/"><span itemprop="name">[GitHub Actions] Pull request 제목 검사</span></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="#conventional-commits%EC%9D%B4%EB%9E%80">Conventional Commits이란</a></li><li><a href="#conventional-pr-title-action">Conventional PR Title Action</a></li><li><a href="#github-actions-%EC%83%9D%EC%84%B1">GitHub Actions 생성</a></li><li><a href="#%EC%99%84%EB%A3%8C">완료</a></li></ul></div><h2 id="개요">개요</h2><p>이번 블로그 포스트에서는 <code>GitHub Actions</code>를 사용하여 <code>Pull request</code>의 제목이 <code>Conventional Commits</code>을 지키는지 검사하는 방법에 대해서 알아보겠습니다.</p><ul><li><a href="https://www.conventionalcommits.org/en/v1.0.0/" rel="nofollow noreferrer" target="\_blank">Conventional Commits</a></li></ul><h2 id="블로그-시리즈">블로그 시리즈</h2><p>이 블로그는 시리즈로 제작되었습니다. 다음 링크를 통해 다른 블로그 포스트도 확인해 보시기 바랍니다.</p><ul><li>[GitHub Actions] Pull request 제목 검사</li><li><a href="https://deku.posstree.com/ko/share/github-actions/release-drafter/" target="\_blank">[GitHub Actions] Release notes 자동화</a></li><li><a href="https://deku.posstree.com/ko/share/github-actions/pr-labels-checker/" target="\_blank">[GitHub Actions] Pull request의 라벨 검사</a></li></ul><h2 id="conventional-commits이란">Conventional Commits이란</h2><p><code>Conventional Commits</code>은 소프트웨어 개발에서 사용되는 커밋 메시지를 표준화하기 위한 규칙입니다. 이것은 코드 변경 사항을 더 읽기 쉽고 자동화된 버전 관리 시스템과 통합하기 쉽도록 만들기 위한 목적이 있습니다.</p><p><code>Conventional Commits</code>은 다음과 같은 구조를 가지고 있습니다.</p><div><pre><code>&lt;type&gt;[optional scope]: &lt;description&gt;

[optional body]

[optional footer(s)]
</code></pre></div><ul><li>타입(Type): 커밋의 의도를 나타내는 단어로, 주로 feat(기능 추가), fix(버그 수정), chore(빌드 및 도구 관련 변경) 등이 사용됩니다.</li><li>범주(Scope): 변경 사항이 어떤 부분에 영향을 미치는지를 지정하는 옵션입니다. Optional이므로 생략할 수 있습니다.</li><li>커밋 메시지(description): 변경 사항의 간결한 설명을 담고 있는 부분으로, 명령문 형태로 작성되어야 합니다.</li></ul><p>여기서 타입은 다음과 같은 종류를 사용할 수 있습니다.</p><ul><li>feat: 새로운 기능을 추가할 때 사용됩니다.</li><li>fix: 버그를 수정할 때 사용됩니다.</li><li>chore: 빌드 프로세스나 도구 관련 작업을 수행할 때 사용됩니다.</li><li>docs: 문서를 변경할 때 사용됩니다.</li><li>style: 코드 스타일을 변경하거나 포맷을 수정할 때 사용됩니다.</li><li>refactor: 코드 리팩토링을 수행할 때 사용됩니다. 기능의 변경 없이 코드의 구조를 개선하는 경우에 해당합니다.</li><li>test: 테스트 관련 코드를 추가하거나 수정할 때 사용됩니다.</li><li>build: 빌드 시스템 또는 외부 종속성에 대한 변경을 나타낼 때 사용됩니다.</li><li>ci: CI/CD 파이프라인에 대한 변경을 나타냅니다.</li></ul><p><code>GitHub</code>에서 <code>Pull request</code>를 만들 때, 브랜치의 첫 커밋 메시지를 기본적으로 사용하게 됩니다. 따라서 커밋을 할 때, <code>Conventional Commits</code>을 지키도록 하면 <code>Pull request</code>를 만들 때, 좀 더 의미 있는 제목을 사용할 수 있습니다.</p><h2 id="conventional-pr-title-action">Conventional PR Title Action</h2><p>이번 블로그 포스트에서는 <code>GitHub Actions</code>으로 <code>Pull request</code>의 제목이 <code>Conventional Commits</code>을 지키는지 검사하기 위해 <code>Conventional PR Title Action</code>을 사용하겠습니다.</p><ul><li><a href="https://github.com/aslafy-z/conventional-pr-title-action/tree/v3/" rel="nofollow noreferrer" target="\_blank">Conventional PR Title Action</a></li></ul><h2 id="github-actions-생성">GitHub Actions 생성</h2><p><code>GitHub Actions</code>에서 <code>Conventional PR Title Action</code>을 사용하기 위해서 <code>.github/workflows/pr-title-checker.yml</code> 파일을 생성하고 다음과 같이 수정합니다.</p><div><pre><code><span>name</span><span>:</span> <span>Check PR title</span>

<span>on</span><span>:</span>
  <span>pull_request</span><span>:</span>
    <span>types</span><span>:</span>
      <span>-</span> <span>opened</span>
      <span>-</span> <span>reopened</span>
      <span>-</span> <span>edited</span>
      <span>-</span> <span>synchronize</span>

<span>jobs</span><span>:</span>
  <span>lint</span><span>:</span>
    <span>runs-on</span><span>:</span> <span>ubuntu-latest</span>
    <span>permissions</span><span>:</span>
      <span>statuses</span><span>:</span> <span>write</span>
    <span>steps</span><span>:</span>
      <span>-</span> <span>uses</span><span>:</span> <span>aslafy-z/conventional-pr-title-action@v3</span>
        <span>env</span><span>:</span>
          <span>GITHUB_TOKEN</span><span>:</span> <span>$</span>
</code></pre></div><p>이 <code>GitHub Actions</code>는 <code>Pull request</code>가 생성되거나 수정될 때, <code>Pull request</code>의 제목이 <code>Conventional Commits</code>을 지키는지 검사하게 됩니다.</p><h2 id="완료">완료</h2><p>이것으로 <code>GitHub Actions</code>를 사용하여 <code>Pull request</code>의 제목이 <code>Conventional Commits</code>을 지키는지 검사하는 방법에 대해서 알아보았습니다.</p><p>제가 이렇게 <code>Pull request</code>의 제목이 <code>Conventional Commits</code>을 지키는지 검사하는 이유는, 이 <code>Pull request</code>의 제목을 사용하여 <code>Release notes</code> 작성을 자동화하기 위해서 입니다.</p><p><code>GitHub Actions</code>를 사용하여 <code>Release notes</code> 작성을 자동화하는 방법에 대해서는 다음 링크를 참고하시기 바랍니다.</p><ul><li><a href="https://deku.posstree.com/ko/share/github-actions/release-drafter/" target="\_blank">[GitHub Actions] Release notes 자동화</a></li></ul><p><code> 제 블로그가 도움이 되셨나요? 하단의 댓글을 달아주시면 저에게 큰 힘이 됩니다! </code></p><h2>앱 홍보</h2><div><p> 지금 보고 계신 블로그를 작성하는 <code>Deku</code>가 개발한 앱을 한번 사용해보세요.<br><code>Deku</code>가 개발한 앱은 Flutter로 개발되었습니다.</p><p> 관심있으신 분들은 앱을 다운로드하여 사용해 주시면 정말 감사하겠습니다.</p></div><h2>책 홍보</h2></article></div></div></div>

dev-yakuza

GitHub Actions를 사용하여 Pull request의 제목이 Conventional Commits을 지키는지 검사하는 방법에 대해서 알아보겠습니다.