概要
GitHub
でPull request
を管理する時、ラベル(Label)
機能を使います。また、Release Drafter
のようにPull request
のラベルを基準にして動作するGitHub Actions
も存在します。
このブログポストでは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
を使うため.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: $
このように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
については詳しい内容は下記のリンクを参考してください。
私は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/[email protected]
env:
GITHUB_TOKEN: $
- uses: danielchabr/[email protected]
with:
hasSome: breaking change,feature,bug,style,refactor,test,chore,docs,ci,dependencies
githubToken: $
このように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
の導入をおすすめします。
私のブログが役に立ちましたか?下にコメントを残してください。それは私にとって大きな大きな力になります!
アプリ広報
Deku
が開発したアプリを使ってみてください。Deku
が開発したアプリはFlutterで開発されています。興味がある方はアプリをダウンロードしてアプリを使ってくれると本当に助かります。