Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/explanation/tech-debt.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,25 @@ available, so the hole reopens for any repository that sets it `true`.

**What would close it:** a validation rule rejecting `verified_allowed: true`
outright, if the ergonomic cost is acceptable.

---

## TD-7 — Generated Terraform reference drift is not gated here

**Status:** accepted for now; tracked for a dedicated follow-up.

This repository's CI runs neither `make ci` nor `make docs-diff`. Changes to
Terraform can therefore leave the generated reference stale while framework CI
remains green. The drift becomes visible only when a consumer runs the full
`make ci`, where `docs-diff` fails.

The gap is accepted temporarily because changing framework PR gating has its own
blast radius and is being handled separately from repairing the current drift.
Consumers still detect the mismatch, but only after it has escaped this
repository's checks.

**What would close it:** add a docs-only framework PR gate that installs
checksum-verified `terraform-docs` 0.23.0 and runs `make docs-diff`.

**How it would be noticed:** a downstream consumer's `make ci` fails at
`docs-diff`, or a maintainer runs `make docs-diff` locally.
5 changes: 3 additions & 2 deletions docs/how-to/develop-this-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ make docs # regenerate docs/reference/terraform.md
make ci
```

If `make ci` is green locally, it is aligned with the Terraform test workflow
in CI.
Local `make ci` is broader than the Terraform test workflow in CI: the hosted
workflow runs `fmt-check`, `init`, `validate`, and `test`, but not the other six
gates, including `docs-diff`.
Loading
Loading