[GitHub Actions] Pull requestのタイトル検索

概要

Gitでコミット(Commit)メッセージを作成する時、特定なルールがあります。体表的なコミットメッセージのルールはConventional Commitsがあります。

Conventional Commits

今回のブログポストではGitHub ActionsのConventional PR Title Actionを使ってPull requestのタイトルがConventional Commitsのルールを従ってるか検査する方法について説明します。

ブログシリーズ

このブログはシリーズで作成しております。下記のリンクを参考して他のブログポストも確認してみてください。

[GitHub Actions] Pull requestのタイトル検査
[GitHub Actions] Release Drafterを使ってGitHubのRelease noteの自動化をする
[GitHub Actions] Pull requestのラベル検査
[GitHub Actions] Changelogファイルの自動アップデート

Conventional Commits

Conventional Commitsは次のようにコミットメッセージの構造に関するルールです。

<type>: <description>

<body>

<footer>

ここでTypeとBody、Footerはオプショナルですが、普通コミットメッセージを作成する時、次のようにTypeを追加して作成します。

fix:: バグ修正の場合
feat:: 機能追加の場合
build:: ビルドシステムまたは依存関係(dependencies)を変更した場合
chore:: ビルドシステムまたは依存関係(dependencies)を変更した場合
ci:: CI設定やスクリプトを変更した場合
docs:: ドキュメントだけ変更した場合
style:: コードスタイル（スペース、フォーマット、コロンなど）を変更した場合
refactor:: バグ修正や機能追加ではなくコードをリファクタリングした場合
pref:: 性能改善をするコード修正の場合
test:: テストコード追加や既存のテストコードを修正した場合

Conventional PR Title Action

Conventional PR Title ActionはPull requestのタイトルがコミットメッセージルールであるConventional Commitsを守ってるのかを検査するGitHub Actionsです。つまり、Pull requestのタイトルにConventional CommitsのTypeを含めてるか検査します。

Conventional PR Title Action

Conventional PR Title Actionを使ってPull requestのタイトルを検査するために.github/workflows/pr-title-checker.ymlファイルを作って次のように修正します。

name: Check PR title

on:
  pull_request:
    types:
      - opened
      - reopened
      - edited
      - synchronize

jobs:
  lint:
    runs-on: ubuntu-latest
    permissions:
      statuses: write
    steps:
      - uses: aslafy-z/[email protected]
        env:
          GITHUB_TOKEN: $

このようにGitHub Actionsを追加したら、Pull requestが生成、修正などが発生した場合Pull requestのタイトルにConventional Commitsのタイプが含まれてるのかチェックされます。

完了

これでGitHub ActionsのConventional PR Title Actionを使ってPull requestのタイトルにConventional Commitsのタイプを含めてあるか検査する方法について見てみました。このようにタイプを検査する理由はRelease Drafterを使ってGitHubのRelease noteを自動化するためです。

GitHub Actions中の1つであるRelease Drafterを使ってGitHubのRelease noteを自動化する方法については下記のブログポストを参考してください。