GitHub Actionsで特定のディレクトリ配下が変更されたときだけワークフローを発火する

概要

GitHub Actionsで特定のディレクトリ配下のファイルが変更されたときにワークフローを発火する方法。

結論

トリガーにpathsを使用する。
下記のように書くとhogeディレクトリ配下のファイルが変更されたときのみワークフローが発火する。

on:
  push:
    paths:
    - 'hoge/**'

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths

ユースケース

  • モノレポで各ディレクトリの変更に対して個別にワークフローを発火する
  • 特定の拡張子が変更された場合のみ発火する
  • ドキュメントの更新でワークフローを走らせたくない

など

まとめ

最近モノレポプロジェクトを触っているのでまとめた。