terraform.yml

name: Terraform docs and formatting
on:
  pull_request_target:
    types:
      - opened
      - synchronize
      - reopened
  push:
    branches:
      - main
jobs:
  formatting:
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
        with:
          ref: ${{ github.event.pull_request.head.sha }}
      - name: terraform fmt
        uses: dflook/terraform-fmt-check@2633e1cf3717ee439e126a537bacc777d620b017
        with:
          path: .
      - name: terraform fmt
        uses: dflook/terraform-fmt-check@2633e1cf3717ee439e126a537bacc777d620b017
        with:
          path: example
  docs:
    needs: formatting
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
        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@d1c99433f7a1e5003ef213d70f89aaa47cb0b675
        with:
          working-dir: .
          output-file: README.md
          output-method: inject
          output-format: markdown table
          git-push: "true"
      - name: Render terraform docs inside the README.md and push changes back to PR branch
        uses: terraform-docs/gh-actions@d1c99433f7a1e5003ef213d70f89aaa47cb0b675
        with:
          working-dir: example/
          output-file: README.md
          output-method: inject
          output-format: markdown table
          git-push: "true"