こんにちは、エンジニアのオオバです。
Unityアプリの自動ビルドは、developへpushするとAndroidとiOSのビルドが走り、配布まで進む仕組みになっていました。
ところが、アプリの中身に関係ないpushでも毎回ビルドが走っていました。
READMEの修正、シェルスクリプトの調整、エディタ拡張の見た目の変更。
どれもアプリの中身は変わりません。
なのに、ビルドの完了を待つことになります。
ビルドは要らなかったのでは?
ここでやりたくなったのが、「ビルドしないpush」を作ることです。
ということで本記事では、Generic Webhook Triggerでpushのファイル一覧を判定に使った方法と、その確かめ方をお届けします。
pushのファイル一覧を正規表現で見て、ビルドが要るpushだけを通した
結論から言うと、ブランチ名の判定に加えて、pushに含まれるファイル一覧を正規表現で判定するようにしました。
除外するのは、.sh・.md・.txtと、Editorフォルダの中にあるファイルです。
ただしEditorフォルダにも例外があるので、あとで触れます。
やりたかったこと
Jenkinsのトリガーには、Generic Webhook Triggerを使っていました。
GitHubのpush通知を受けて、refがdevelopかどうかで起動を決めていた仕組みです。
ブランチで絞っているので、developへのpushは中身に関係なく全部ビルドされます。
やりたかったのは、アプリに関係するファイルが含まれるpushだけを通すことでした。
そのためには、push通知の中にあるファイル一覧を判定に使う必要があります。
やったこと
push通知のファイル一覧を取り出す
push通知には、コミットごとのadded(追加)、modified(変更)、removed(削除)のファイル一覧が入っていました。
マージコミットにも一覧が付いていたので、PRのマージも同じ判定で扱えます。
Generic Webhook Triggerの変数として、この3つを足しました。
具体的には $.commits[*].added[*]、modified、removed の3つです。
プラグインはこれを ["a.md","b.cs"] のようなJSON配列の文字列にしてくれます。
判定する文字列を組み立てる
判定の対象は、リポジトリ名、ref、そして3つのファイル一覧を # でつないだ1本の文字列にしました。
ブランチとファイルを同じ文字列に入れておけば、正規表現1本で条件を書けます。
書きたい条件は「developへのpushで、除外対象ではないファイルが1つでもある」です。
正規表現で気をつけたこと
正規表現で一番大事だったのは、ファイル名の先頭から照合を始めることでした。
最初は " だけを探す書き方をしていました。
ところが、"a.md","b.md" のように並んでいると、ファイルとファイルの間の "," が「1文字のファイル名」として一致してしまいます。
なので、要素の先頭([ か , の直後の ")から書き始めました。
残りは否定先読みで除外します。
- .sh / .md / .txt(とその .meta)で終わるファイル
- /Editor/ の中にあるファイル、またはEditor.meta
確かめ方
実際にwebhookを投げると、そのままビルドが走ってしまいます。
そこで、Jenkinsのスクリプトコンソールから、プラグインのクラスを直接呼びました。
呼んだのは PostContentParameterResolver と Renderer.isMatching です。
過去のビルドログには、printPostContent=trueにしていたおかげで通知の中身が残っていました。
その本物の通知を取り出し、ファイル一覧だけを差し替えて10パターン判定しました。
ビルドが起動しなかったケース
- .shのみの変更
- .md・.txtのみの変更
- Editorフォルダの.csと.meta
- README.md.meta
- ファイル一覧が空
- 別ブランチへのpush
ビルドが起動したケース
- .mdとランタイムの.csが混ざっているもの
- プレハブ
- 本体ファイルの削除だけ
MyEditorToolのように、名前にEditorを含むだけのフォルダ
フォルダ名は /Editor/ の区切りで見ているので、MyEditorTool は除外に入りません。
注意:Editorフォルダでもアプリの中身が変わるもの
Editorフォルダでも、アプリの中身を変えるものがあります。
ビルド処理、ビルド後処理、AssetPostprocessorがそうでした。
これらを変えたときは自動では走らないので、手動でビルドする運用にしました。
つまり、判定から外れた部分は人が見る、ということ。
push通知のcommitsは最大20件です。
ただし、マージコミットにはファイル一覧が付くので、PRのマージの判定には影響しません。
学び
今回の一番の学びは、区切り文字を含む文字列を正規表現で扱うときは、要素の境界から書くことでした。
" だけで探すと、区切りの "," まで要素に見えてしまいます。
もう1つは、本番のwebhookを投げずに、ログに残っていた本物の通知で判定だけ試せたことです。
ビルドを走らせずに確かめられたので、やり直しの待ち時間もありませんでした。
まとめ
ビルドが要らないpushを、判定で外せるようになりました。
ビルド待ちが減ると、確認したいことにすぐ戻れます。
Jenkinsのビルド時間そのものを縮めた話は、こちらにまとめています。
👉 JenkinsのUnityビルドが毎回40分:git cleanとLibraryキャッシュをシンボリックリンクで両立した

筆者のXをフォローしよう
- Jenkins 2.492.3 / generic-webhook-trigger 2.3.1









