はじめに
2023年のRe:inventにて登場したGit sync。CloudFormationとGit間で、スムーズな接続ができる魅力的な機能です。2024年9月に、Pull Requestに自動でコメントする機能が追加されたので、実際に使ってみた結果を記事にしてみたいと思います。
↓ Git Syncでコメント機能追加のアナウンス
↓ 使い方マニュアル
Git Syncとは
GitHub、GitHub Enterprise、GitLab、BitbucketからCloudFormationに接続できる仕組み。
テンプレートまたはデプロイファイルへの変更をコミットすると、CloudFormation はスタックを自動的に更新します。これにより、プルリクエストとバージョントラッキングを使用して、一元化された場所から CloudFormation スタックの設定、デプロイ、更新を行うことができます。
Git Syncのコメント機能の使い方
Git Syncの設定から、Enable comment on pull requestを有効にすると使えます。
設定すると、変更の有無に関わらず、Pull requestに自動でコメントが追加されます。
修正内容があった場合の通知内容は以下のようになるようです。
（引用：[アップデート] AWS CloudFormation の Git 同期機能がプルリクエストにスタック変更内容をコメントしてくれるようになりました）
実際に使ってみて
自動でコメントがついてくれるのはありがたいと思いました。
ただ、今回作成したGit Syncは、以下のようなものでした。
- Git Syncが設定されているCfnスタック以外のコードも含まれているGitHubリポジトリで作成
- Git Syncはmasterブランチで設定
そのため、Git Syncとは関係ないコードを修正したmasterブランチのPull Requestにも、コミットの度に、「変更点はありません」というようなコメントが付いてしまいました。それを受けて、自動コメント機能はOFFに設定しました。
今回の経験から、自動コメント機能が適しているケースとそうでないケースについて考えてみました。
- 自動コメント機能が適しているケース
- Git Syncを設定したCfnスタックのみのGitリポジトリ
- 使用頻度の低いブランチでGit Syncを設定している
- 自動コメント機能が適していないケース
- Git Syncを設定したCfnスタック以外にも様々なコードが含まれているGitリポジトリ
- main・masterブランチ等、多くの開発者が頻繁にPull Requestを出すブランチでGit Syncを設定している
自動コメント機能は便利な一方で、ノイズにもなりやすいと分かったので、ケースによって使い分けていきたいと思いました。
以上です。ありがとうございました。