terraform.yml

name: Terraform docs and formatting
on:
  pull_request: {}
  push:
    branches:
      - main
jobs:
  formatting:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
        with:
          ref: ${{ github.event.pull_request.head.sha }}
      - name: terraform fmt
        uses: dflook/terraform-fmt-check@c9309dc072b71dded0f23b29e3ffd4406e27c078
        with:
          path: .
      - name: terraform fmt
        uses: dflook/terraform-fmt-check@c9309dc072b71dded0f23b29e3ffd4406e27c078
        with:
          path: example
  docs:
    needs: formatting
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
        with:
          ref: ${{ github.event.pull_request.head.ref }}
      - name: Render terraform docs inside the README.md and push changes back to PR branch
        uses: terraform-docs/gh-actions@d8f1a2272f04d6124103eb65815f007e091e756a
        with:
          working-dir: .
          output-file: README.md
          output-method: inject
          output-format: markdown table
          indention: 3
          git-push: "true"
      - name: Render terraform docs inside the README.md and push changes back to PR branch
        uses: terraform-docs/gh-actions@d8f1a2272f04d6124103eb65815f007e091e756a
        with:
          working-dir: example/
          output-file: README.md
          output-method: inject
          output-format: markdown table
          indention: 3
          git-push: "true"