【GitHub】プルリクエストのタイトルがConventional Commitsに則っているか検証する方法

action-semantic-pull-requestを使用してプルリクエストのタイトルがConventional Commitsに則っているのか検証できます。

導入方法

.github/workflows/semantic-pull-request.ymlを以下の内容で作成します。

.github/workflows/semantic-pull-request.yml

name: "Lint PR"

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

permissions:
  pull-requests: read

jobs:
  main:
    name: Validate PR title
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

プルリクエストのタイトルをコミットメッセージのタイトルにするため、リポジトリのSettings > General > Pull RequestsでAllow squash mergingにチェックを入れ、Default commit messageをPull request titleに変更します。