GitHub ActionsでTerraform fmtのチェックを自動化する

はじめに

この記事では、Terraform を書いているときに、Terraform fmt をしているかどうかを GitHub Actions で確認する方法を紹介します。

モチベーション

GitHub Actions に限らず、Terraform を実装するときに、CI/CD で plan や apply、また fmt のチェックをしたいケースというのは出てきます。

Terraform の場合、書き方などは公式の Terraform fmt を利用するのが良いとされていますが、複数人で実装する場合、たまにその Terraform fmt が適用されていないケースがあります（忘れてしまったとかで）。

それをチェックするのを自動で行いたいというのが今回のモチベーションです。

GitHub Actions での設定方法

Terraform 公式のsetup-terraformというのを利用して設定します。

name: Terraform fmt checker

on: [push]

jobs:
  terraform-fmt-checker:
    name: Terraform fmt checker
    runs-on: ubuntu-latest

    defaults:
      run:
        shell: bash

    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Setup Terraform
        uses: hashicorp/setup-terraform@v1
        with:
          terraform_version: 1.0.11

      - name: Terraform Format
        run: terraform fmt -recursive -check

これを設定しておくことで、リポジトリ配下の Terraform ファイルを全てチェックしてくれるようになります。

以上です。

参考

• setup-terraform
• GitHub Actions で setup-terraform を試す

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。