モノレポなライブラリ群をCICDでデプロイした話

2023年4月の.NETラボで発表した資料です。
デモのコード: https://github.com/Takas0522/dotnetlab-demos/tree/main/2023/03-monolib-deploy
発表の動画: https://www.youtube.com/live/FAwLd6eOTjc

Transcript

1. モノレポなライブラリ群をCICDでデプロイした話 2023.03 .NETラボ
2. 誰？ Takas(@DevTakas) Angular / Azure / .NET Core / Azure DevOps / Microsoft Graph Microsoft MVP M365 Development
3. 誰？ ブログやってます http://takasdev.hatenablog.com/ 「はまったりひらめいたり…とか…」
4. 前回の続き モノレポなライブラリ群をCICDしたくて色々試した話 - Speaker Deck
5. 1. 今回のお題
6. 1. 今回のお題 • ライブラリ間は依存がありその依存を解消する必要がある • 依存元が更新されたら利用ライブラリも更新されてほしい • ライブラリのバージョンアップなど面倒なものを自動化したい • package.jsonの更新→ビルド→publish→Gitタグ付け→Commit→Push… • CHANGELOG.md記載の自動化 • そしてそれらをなるたけ簡略化して管理したい • CIのYAMLのメンテ工数を削減したい… モノレポライブラリをどのように公開するのか
7. 1. 今回のお題 モノレポライブラリをどのように公開するのか これを変更したらcontrol-oneもbaseも 更新されてほしい
8. 2.オーソドックスなCDを考えてみる
9. Control One Utility 2.オーソドックスなCDを考えてみる • npmのコマンドを使用してバージョンアップ • npm version (major | minor | patch) ...コマンドの実行 • ただし上記コマンドを実行したいのは「変更あったものだけ」 • 変更：ライブラリコードの変更＋依存ライブラリの変更 • たとえばregisty_packageイベントをトリガーにCIを作る？ • CIの数めっちゃ多くなりそう JS(Angular)ライブラリの構成 Utility変更トリガーCI UtilityのCIトリガーCI CO変更トリガーCI …
10. 3.お題を解決するためにツールを利用する
11. 3.お題を解決するためにツールを利用する • 前回のTurborepoやnxと同じモノレポ管理ライブラリ • Turborepoのビルド設定の元ネタになっているらしい • できることは少なめ(簡単に使えるとも言う) • Microsoft製OSS • デフォでAzure Blob Storageを使ってキャッシュできる Lage
12. 3.お題を解決するためにツールを利用する • Turborepoと同じような設定内容 Lageの設定 module.exports = { pipeline: { build: { dependsOn: ["^build"], outputs: [ "dist/**" ] }, lint: [ "^lint" ], test: { dependsOn: ["build","^test"] } } };
13. 3.お題を解決するためにツールを利用する • パッケージの公開周りの管理ツール • npみたいなやつ • できることは少なめ（簡単にry • Microsoft製OSS • msal.jsとかに使われているよう beachball
14. 3.お題を解決するためにツールを利用する • イニシャルは設定なしでも使えそう beachballの設定
15. 3.お題を解決するためにツールを利用する • check • Git上の変更からChangeLogが発行されているかチェックする • CI上で実行すると便利 • change • git上変更からChangeLogを発行する • bump • publish時の挙動を確認できる • publish • Change Logを材料にPublish作業を行う • バージョンアップ修正/npm publish/CHANGELOG.mdの作成 を行ってくれる beachballの基本コマンド
16. 4.デモ
17. 4.デモ Beachballのコマンドを触ってみる
18. 4.デモ UtilityをCDする
19. 4.デモ UtilityをCDする
20. 4.デモ Control OneをCDする
21. 4.デモ ControlOneをCDする
22. 4.デモ Control TwoをCDする
23. 4.デモ ControlTwoをCDする
24. 4.デモ BaseをCDする
25. 4.デモ BaseをCDする
26. 5.まとめ
27. 5.まとめ • モノレポライブラリデプロイの問題点 • 依存関係の解決、ドキュメントの作成・・・ • それらを解決するためのライブラリがあることを確認 • 今回は「beachball」を利用 • ライブラリを使った結果どうなったかデモで確認
28. 参考ページ • monorepo.tools • https://monorepo.tools/ • ワークフローをトリガーするイベント - GitHub Docs • https://docs.github.com/ja/actions/using-workflows/events-that- trigger-workflows#registry_package • beachball • https://microsoft.github.io/beachball/ • lage • https://microsoft.github.io/lage/