terraform-docs.yml

---
name: Generate terraform docs

on:
  pull_request:
    branches:
      - main
    paths:
      - "**.tf"
      - ".github/workflows/terraform-docs.yml"
  push:
    branches:
      - "test/terraform-docs/**"
    paths:
      - "**.tf"
      - ".github/workflows/terraform-docs.yml"
  workflow_dispatch:

permissions:
  contents: write

concurrency:
  group: terraform-docs-${{ github.ref }}

jobs:
  terraform-docs:
    name: terraform docs
    runs-on: ubuntu-latest
    timeout-minutes: 10
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: modules
            directory: modules
          - name: usecases
            directory: usecases

    steps:
      - name: Checkout source code
        uses: actions/checkout@v4.1.1
        with:
          ref: ${{ github.event.pull_request.head.ref }}

      - name: Render terraform docs and push changes back to PR
        uses: terraform-docs/gh-actions@v1.1.0
        with:
          find-dir: "./terraform/${{ matrix.directory }}"
          output-file: USAGE.md
          output-method: inject
          git-push: true
          args: --hide-empty