令和 3 年 11 月に開催したKLab TECH Meetup #8のセッション資料です。 https://klab-tech-meetup.connpass.com/event/228398/

1. 鹿谷 将司
バックエンドアーキテクチャG
技術統括部
属人化して詰まってた作業を
自動化で楽しようとした話
KLab株式会社

2. 自己紹介
名前: 鹿谷 将司
社歴: 4年目
担当: アセットの展開スクリプトの改修など
悩み: お仕事失敗しがち...

3. 先に結論
● 楽自体はできた
○ 毎日数時間の作業 -> ほぼ0に
● 属人化の解消、とはならなかった
● ざっくりと概要の共有は早めにしておいた方が良い

4. どんなことをしていたのか
GHE 上のアセットから AB を作るジョブの実行と前後作業
日本版/海外版それぞれ2環境、合計4環境
※GHE
アセット
AB(アセットバンドル)
: GitHub Enterprise
: ゲーム内で使用する素材(画像、3Dモデルなど)
: Unity アプリ用の素材形式

5. 全体像
アセット納品
(PR) アセット AB 確認
テストチーム
企画チーム
制作チーム

6. 全体像
アセット納品
(PR) アセット AB 確認
テストチーム
企画チーム
制作チーム
僕
PRレビュー
ブランチの
マージ ビルド
&
終了確認
ビルド終了の
連絡

7. アセット納品
(PR)
PRレビュー
制作の方から PR レビューがくるのでそのチェック
● アセットの取り込み PR
● ビルド上の問題がないか
僕
PRレビュー

8. ブランチのマージ
リリース日毎にブランチが切られており
リリース日以降の他のブランチにもマージする必要がある
アセットA納品
release/0331: こっちにアセットAあり
release/0401: こっちにはまだアセットAなし

9. アセットA納品
ブランチのマージ
リリース日毎にブランチが切られており
リリース日以降の他のブランチにもマージする必要がある
release/0331: こっちにアセットAあり
release/0401: こっちにもアセットAあり
マージ

10. ビルド
jenkins に渡すアセットのあるブランチをパラメータで指定
ブランチ上のアセットに対応するABのみが環境に展開される
4/1の AB 展開後、3/31 の AB を展開すると環境から 4/1 分の AB が消える
ブランチ上の
アセット
対応するAB
x3

11. どんなことをしていたのか(後作業)
● ビルド終わったら各所へ連絡
○ テストチームのどなたかだったり、
○ 制作チームのどなたかだったり、
○ 企画チームのどなたかだったり
テストチーム
企画チーム
制作チーム
僕
終わった?
まだ/終わった!
終わりました!
確認お願いしま
す!

12. 僕が引き継ぐ前の昔の話
先輩が
● 適切な時に PR のレビューを行い、
● リリースブランチのマージをして、
● いい感じにパラメータを指定して、
● 程よい粒度で確認に間に合うよう、
● 終わったら漏れなく連絡を入れて、
うまく回っていた

13. -> 忘れがち
-> 忘れることがしばしば
-> パラメータミス、更新漏れ...
-> うまいタイミングがつかめず
-> 忘れがち...
引き継いだ後
僕が引き継いでからというもの...
● 適切な時に PR のレビューを行い、
● リリースブランチのマージをして、
● いい感じにパラメータを指定して、
● 程よい粒度で確認に間に合うよう、
● 終わったら漏れなく連絡を入れて、
失敗続き...

14. 忘れないよう頑張る
常に画面にメモを残す
-> 記載が漏れる
別のことに集中してメモを見るのを忘れる

15. 忘れないよう頑張る
slack の /remind、google calendar
メモと違い時間になると通知が出る
-> 記載g…
ざっくりと自分で通知タイミングを見計らう必要がある
○ ミスると遅延、再通知(これも忘れる可能性がある)

16. 注意しなきゃ...では治らなかった
どんなに注意してても自分のレベルだと忘れてしまった

17. 当時の私
どうしても忘れてしまう...ならどうする?

18. 当時の私
どうしても忘れてしまう...ならどうする?
-> 自動化すれば忘れるも何もないだろう

19. 詰まっていた現状に
● PRのレビューを忘れてしまい
● リリースブランチのマージを忘れがち、
● パラメータは間違える、
● パラメータ更新もよくミスり、
● タイミングもうまくできず、
● 連絡も忘れがち...

20. 自動で回るように仕組みを導入
● PRのレビューを忘れてしまい
● リリースブランチのマージを忘れがち、
● パラメータは間違える、
● パラメータ更新もよくミスり、
● タイミングもうまくできず、
● 連絡も忘れがち...
-> テストを導入
-> 自動マージできるように
-> デフォルト値の追加
-> パラメータの自動更新
-> 定期実行に
-> 開始/終了時にslack通知

21. PRのレビュー
PR テストの導入(なぜか導入されていなかった...)
● 制作チームの方だけでマージできる
● エラーメッセージを分かりやすく目立つように
○ 簡単にチェック内容と修正方法の説明

22. リリースブランチのマージ
別プロジェクトの PR 作成、自動マージするスクリプトを導入
git ls-remote | grep ‘name-pattern’ で一覧を取得
● 自動で一覧を更新することで取り込み漏れを防ぐ
● マージを自動ですることで実行漏れを防ぐ

23. デフォルトパラメータの設定
各環境用の専用ジョブを作り、デフォルトパラメータを設定
● 何も考えずにビルドをキック可能に
○ 各環境に必要なパラメータで展開できる
● 特殊なケースは従来通りパラメータで指定

24. デフォルトパラメータの更新
ブランチのマージスクリプトと似た仕組みでデフォルトパラ
メータの更新をするように
● パラメータの更新漏れを防ぐ

25. ビルドの定期実行
jenkins の定期実行を使用しビルドをキック
● 手動のパラメータ指定がデフォルト値で OK になったの
で、定期的に実行できるようになった
● ビルドし忘れを防げるように!

26. 開始、終了時の slack 通知
ビルド開始、終了時ジョブの一部として slack 通知
● 終了すれば slack に通知 -> ジョブの終了確認は不要
● 開始時点でも通知がいくので、制作の方も実行されてい
るのに気づける

27. 自動化の成果
毎日数時間割いていた作業工数がほぼ0に!
パラメータミスもない!
制作の方の連絡コストも削減!
Happy!
やったね!

28. 新たな課題
と思ったものの新たな課題が...
● 例外ケースやビルド失敗時の手順が煩雑に
● ビルドの割り込みがしにくい
● 何より手動で実行できるのが自分しかいない

29. 例外ケースやビルド失敗時の手順が煩雑に
使っていなかった仕組みを使った分、エラーの原因は増える
例)ブランチ一覧を取得し、パターンに合致するブランチ間でマージをするスクリプト
● 既に同じ base, head の PR があると停止する
○ 前の実行時のが残っていると失敗してしまう

30. 割り込みがしにくい
ジョブを定期実行しているため、手動ビルドを割込ませるに
はキューに積まれてるビルド予約を止める必要がある
● 直感的には現在のジョブを止めれば OK と思うが、他に
も処理が必要

31. 手動で実行や改修ができるのが自分しかいない
ジョブの説明を諦めてしまったために、ジョブの仕組みが周
りに伝わっていない問題が残ってしまっている
仕組みのわからないものを触ってくださる方は少ない
当然改修も属人化したまま

32. まとめ1
自動化によって得られるメリットも大きい
● 漏れの削減
● ミスの軽減
● 拘束時間の短縮

33. まとめ2
手動実行や改修のためにも、早期での共有が望ましい
● 特殊なケースの実行を多くの方ができるように
● 改修のボトルネックが発生しにくいように
● 仕組みが複雑になり説明が難しくなる前に...

34. ご静聴ありがとうございました