GitHub Actionsでterraform fmtをチェックする方法をメモします。
はじめに
こんにちは、@bioerrorlogです。
コードのフォーマットチェックをCIで自動担保させることは、シンプルですが大切なことです。
今回は、GitHub Actionsでterraform fmtチェックを実行させるミニマムな方法の備忘録を残します。
GitHub Actionsでterraform fmt
name: Terraform fmt check on: push: jobs: tf-fmt: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: hashicorp/setup-terraform@v2 with: terraform_version: 1.2.7 - name: Terraform fmt run: terraform fmt -check -recursive
ソースコードはこちら: github.com
setup-terraformを使うと簡単にGitHub Actions上でterraformをインストールできるので、これを使っています。
フォーマットチェックはterraform fmt -check -recursive
コマンドで行っています。
-check
: フォーマットが必要な部分が残っている場合に異常終了する-recursive
: ディレクトリを再帰的にチェックする
よってこのActionsを入れておくと、レポジトリ内のどこかでフォーマットが必要な部分が残っているとCIが落ちるようになります。
おわりに
以上、GitHub Actionsでterraform fmtをチェックする方法のちょっとした備忘録でした。
どなたかの参考になれば幸いです。
[関連記事]
参考
GitHub - hashicorp/setup-terraform: Sets up Terraform CLI in your GitHub Actions workflow.
Workflow syntax for GitHub Actions - GitHub Docs
terraform-examples/tf-fmt.yml at main · bioerrorlog/terraform-examples · GitHub