jimeh/terraform-cloudflare-email
1
0
Fork 0
mirror of https://github.com/jimeh/terraform-cloudflare-email.git synced 2026-02-19 09:56:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: automate README docs generation and formatting

Browse Source 
Manual `terraform-docs markdown .` was fragile — no injection markers,
no idempotency check, and no consistent formatting pipeline.

Add terraform-docs inject mode with BEGIN/END_TF_DOCS markers in the
README so `terraform-docs .` regenerates only the managed section.
Wrap the injected block with prettier-ignore directives to prevent
prettier from reformatting tables (which would break terraform-docs
--output-check).

Restructure Makefile with three targets:
- `docs`: regenerate terraform-docs + prettier format README
- `fmt`: docs + terraform fmt -recursive
- `check`: verify all docs/formatting are current (CI-friendly)

Add node (LTS) and prettier to .mise.toml for markdown formatting.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Jim Myhrberg
2026-02-02 14:32:57 +00:00
parent 1c2115b725
commit 8bdc77a2c9
4 changed files with 64 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.terraform-docs.yml Normal file
View File

@@ -0,0 +1,8 @@
formatter: "markdown table"
output:
file: "README.md"
mode: inject
settings:
hide-empty: false
read-comments: true