terraform-docs.yml

# This is a Terraform-managed file; manual changes will be overwritten.
# see https://github.com/workloads/github-organization/blob/main/templates/workflows/terraform-docs.tftpl.yml

---

name: "Documentation: terraform-docs"

# yamllint disable-line rule:truthy
on:
  push:

# see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions
permissions: read-all

jobs:
  workflow:
    # only run if workflows are enabled
    if: ${{ vars.ENABLE_WORKFLOWS == 'true' }}

    # see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
    concurrency:
      group: "${{ github.workflow }}-${{ github.ref }}"
      cancel-in-progress: true

    name: Terraform Docs

    # see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions
    permissions:
      contents: write

    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      # see https://github.com/actions/checkout/releases/tag/v4.1.6
      - name: Checkout Repository
        uses: "actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29"  # ref: `tags/v4.1.6`
        with:
          ref: "${{ github.event.pull_request.head.ref }}"
          fetch-depth: 1

      # see https://github.com/terraform-docs/gh-actions/releases/tag/v1.1.0
      - name: Render documentation for repository and push changes back to branch
        uses: "terraform-docs/gh-actions@7a62208a0090636af2df1b739da46d27fd90bdc6"  # ref: `tags/v1.1.0`
        with:
          config-file: ".terraform-docs.yml"
          output-file: "README.md"
          output-method: inject"
          git-push: true
          working-dir: "./"

  workflow-inactive:
    # only run if workflows are disabled
    if: ${{ vars.ENABLE_WORKFLOWS != 'true' }}

    name: Workflow Status
    runs-on: ubuntu-latest
    timeout-minutes: 1

    steps:
      - name: Display Workflow Status
        # shellcheck disable=SC2006
        run: echo "::notice title='Workflow is not currently active'::'Check if `ENABLE_WORKFLOWS` is set to `true`.'"