Skip to content

make docs

make docs #9

Workflow file for this run

name: Lint and Test
on:
push:
jobs:
lint-test:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
- name: Setup Terraform
uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3
with:
terraform_version: latest
- name: Setup Go
uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5
with:
go-version: "stable"
- name: Install terraform-docs
run: go install github.com/terraform-docs/terraform-docs@v0.20.0
- name: Terraform Format Check
run: terraform fmt -check -recursive .
- name: Generate Documentation
run: make docs
- name: Check for Documentation Changes
run: |
if ! git diff --exit-code README.md; then
echo "❌ Documentation is out of date. Please run 'make docs' and commit the changes."
exit 1
else
echo "✅ Documentation is up to date."
fi
- name: Terraform Init
run: terraform init
- name: Terraform Validate
run: terraform validate