terraform-docs.yml

# Copyright (c) CloudBees, Inc.
---

name: "Documentation: terraform-docs"

on:
  pull_request:
    paths:
      - '**.tf'
      - '**.yaml'
      - '**.yml'

jobs:
  docs:
    name: Terraform_Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0
        with:
          repository: ${{ github.event.pull_request.head.repo.full_name }}
          ref: ${{ github.event.pull_request.head.ref }}

      - name: Render documentation and push changes back to branch
        uses: terraform-docs/gh-actions@f6d59f89a280fa0a3febf55ef68f146784b20ba0 # v1.0.0
        with:
          config-file: ".terraform-docs.yml"
          output-file: "README.md"
          output-method: inject
          git-push: true

      - name: Render documentation for `01-getting-started` example and push changes back to branch
        uses: terraform-docs/gh-actions@f6d59f89a280fa0a3febf55ef68f146784b20ba0 # v1.0.0
        with:
          config-file: ".terraform-docs.yml"
          output-file: "README.md"
          git-push: true
          working-dir: "./blueprints/01-getting-started"

      - name: Render documentation for `02-at-scale` example and push changes back to branch
        uses: terraform-docs/gh-actions@f6d59f89a280fa0a3febf55ef68f146784b20ba0 # v1.0.0
        with:
          config-file: ".terraform-docs.yml"
          output-file: "README.md"
          git-push: true
          working-dir: "./blueprints/02-at-scale"