Skip to content

chore: Update README.md and Terraform module template #175

chore: Update README.md and Terraform module template

chore: Update README.md and Terraform module template #175

Workflow file for this run

name: Terraform Docs
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
tf-docs:
name: Generate Terraform Docs
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: Begin CI...
uses: actions/checkout@v4
with:
# If the event that triggered the workflow is a pull request, then the variable contains ${{ github.event.pull_request.head.ref }}
# If the event that triggered the workflow is a push, then the variable contains ${{ github.ref }}
ref: ${{ github.event.pull_request.head.ref || github.ref }}
- name: Render terraform docs inside modules
uses: terraform-docs/[email protected]
with:
working-dir: modules/*,live/*
output-file: docs/MODULE.md
output-method: replace
git-push: "true"