shirakiya/setup-tfcmt を作った
GitHub Actionsで利用可能なactionとして「shirakiya/setup-tfcmt」を作成・公開しました。
GitHub Marketplace上の名前は「setup-tfcmt-action」です。
tfcmtについて
tfcmtという、GitHub Actions等のCIで行った terraform plan
や terraform apply
の結果を見やすい形に整形してGitHubのプルリクエストにコメントするCLIツールがあります。
※結果を整形するだけでなく、同一のプルリクエストで複数回 terraform plan
したとしてもtfcmtが投稿したコメントを修正してプルリクエストのタイムラインを長く見づらい形にしないなど、細かい配慮もあるスグレモノで本当に便利です。
詳しい機能については以下のドキュメントを参考にしてください。
shirakiya/setup-tfcmtについて
shirakiya/setup-tfcmt はGitHub Actions上で簡単にtfcmt
コマンドを利用できるようにするためのactionです。例えば actions/setup-node
に近いイメージのものです。
- uses: shirakiya/setup-tfcmt@v1
- name: tfcmt plan
run: tfcmt plan -patch -- terraform plan -no-color
特徴
-
ubuntu-latest
,windows-latest
,macos-latest
の各ランナーに対応 - tfcmtのバージョン指定が可能、デフォルトでは最新リリースのバージョンを使用
-
tfcmd
コマンドをキャッシュ (※self-hosted runnnerのみ)
詳しい使い方等はREADMEに記載しています。
おわりに
terraform plan
や terraform apply
の結果の整形が本当にいい感じで、今まで terraform plan
等の結果をそのままコメントしていて長い出力にうんざりしていた人にとってはとても便利に感じ取れるものだと思います。
tfcmtをGitHub Actions上で使ってみたい・インストールの実装をもっと楽したいという方はぜひ使ってみてください。
最後にtfcmtの作者であるsuzuki-shunsukeさんにおかれまして、setup-tfcmtの公開を快く許可いただき感謝申し上げます。
Discussion