[GitHub Actions] Pull requestのラベル検査

概要

GitHubでPull requestを管理する時、ラベル(Label)機能を使います。また、Release DrafterのようにPull requestのラベルを基準にして動作するGitHub Actionsも存在します。

[GitHub Actions] Release Drafterを使ってGitHubのRelease noteの自動化をする

このブログポストではGitHub ActionsのPR Labels Checkerを使ってPull requestのラベルがうまく設定されたかどうかチェックする方法について説明します。

ブログシリーズ

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

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

PR Labels Checker

PR Labels CheckerはPull requestのラベルが適用されたかチェックするGitHub Actionsです。

PR Labels Checker

PR Labels Checkerを使うため.github/workflows/labels-checker.ymlファイルを作って次のように修正します。

name: Labels Checker

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

jobs:
  check_labels:
    runs-on: ubuntu-latest
    steps:
      - uses: danielchabr/[email protected]
        with:
          hasSome: breaking change,feature,bug,style,refactor,test,chore,docs,ci,dependencies
          githubToken: ${{ secrets.GITHUB_TOKEN }}

このようにGitHub Actionsを生成したら、Pull requestにbreaking change, feature, bug, style, refactor, test, chore, docs, ci, dependencies中で1つのラベルが設定されないとエラーが発生するようになります。

この例題で設定したラベルはRelease DrafterでRelease noteを自動で作成するため使ったラベルです。

Release Drafter

私はGitHubのRelease noteを自動化するためRelease Drafterを使ってます。Release Drafterについては詳しい内容は下記のリンクを参考してください。

[GitHub Actions] Release Drafter를 사용하여 GitHub의 Release note 자동화 하기

私はRelease Drafterのautolabelerがラベルをうまく設定したか確認するため下記のようにGitHub Actionsを使ってます。

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: ${{ secrets.GITHUB_TOKEN }}
      - uses: danielchabr/[email protected]
        with:
          hasSome: breaking change,feature,bug,style,refactor,test,chore,docs,ci,dependencies
          githubToken: ${{ secrets.GITHUB_TOKEN }}

このようにGitHub Actionsを構成するとPull requestが生成される時、Release Drafterによってラベルが設定され、その後PR Labels Checkerがラベルがうまく設定されたか確認するようになります。Release Drafterのautolabelerがレベルをうまく設定してくれますが、念のためもう一度チェックするように構成してます。

完了

これでGitHub ActionsのGitHub Actionsを使ってPull requestのラベルがうまく設定されたか確認する方法について見てみました。Pull requestのラベルを利用するGitHub Actionsを使ってる場合、ラベルを使ってプロジェクトを管理してる場合、PR Labels Checkersの導入をおすすめします。

Github Sponsor

Buy me a coffee

私のブログが役に立ちましたか？下にコメントを残してください。それは私にとって大きな大きな力になります！