Terraform Module Publishing Checklist Generator

Shipping a Terraform module to a registry means meeting a set of quality and consistency expectations that are easy to forget under deadline pressure. The Publishing Checklist Generator builds a Markdown release checklist you can work through before publishing, marking the items you have already completed so nothing slips through. It also doubles as release evidence for reviewers who want proof the quality gate was actually followed before a tag.

Enter the module name, the provider it targets, the destination registry, and an optional version, then tick the quality items you have done: README, runnable examples, automated tests, changelog, license, CI, semantic versioning, documented inputs and outputs, linting, and pinned providers. The tool emits a checklist with your completed items pre-checked and a short release-steps section with the tagging and consume commands. Everything runs locally in your browser, so no module name, provider, or registry choice is uploaded and no publish call is made. That keeps your release planning private while still giving you a repeatable, shareable checklist you can paste into an issue, a pull request, or a runbook for the next release.

• Tracked items - README, examples, tests, changelog, license, CI, semver, docs, lint, and provider pinning are all tracked.
• Mark done - completed items render as checked boxes in the generated checklist.
• Release steps - tagging and consume commands are generated for the version you enter.
• Progress stat - a live counter shows how many items are done out of the total as you build it.
• Registry aware - the target registry is printed at the top of the checklist for clarity.
• Private - the form is processed in your browser; nothing is sent anywhere at any point.
• Sample loader - one click fills a realistic partly-done example so you can see the expected shape.
• Copy, download, print - export checklist.md in the format your workflow expects.
• Tag helper - the release steps include a ready git tag command built from the version you entered.
• Consume snippet - a copy-paste source and version line is included so consumers know how to call the module.

1. Name the module and the provider it is built for, such as aws or google.
2. Pick the target registry from public, private, or both.
3. Enter a version if you already know the release number, or leave it blank for a sensible default.
4. Check the items you have finished so they appear ticked in the output.
5. Click Generate checklist to build the Markdown release list.
6. Review the progress stat to see how complete your release readiness currently is.
7. Copy, download, or print the checklist and attach it to your release issue.
8. Work the remaining items before you actually tag and publish the module to the registry.
9. Re-run after changes - regenerate the checklist whenever scope shifts so the readiness picture stays honest to the end.

Example 1 - public registry module. Name vpc, provider aws, registry Public Terraform Registry, version 5.0.0, with README, tests, license, and semver done. The checklist shows those four items checked and leaves examples, changelog, CI, docs, lint, and pin to finish before publishing, giving a clear punch list.

Example 2 - private module. Name cache, provider aws, registry Private Registry, with only CI done. The output reflects a mostly-unfinished release so the team can plan the remaining work and avoid a premature tag.

Example 3 - both registries. Name network, provider aws, registry Both, version 2.1.0, with README, examples, tests, and docs done. The checklist notes the target as Both and the consume snippet uses the public-style source, which is handy when a module is mirrored across internal and public registries.

• Consistent releases - the same quality gate applies to every module you ship, across teams and repositories.
• Nothing forgotten - a visible checklist catches the easy-to-skip steps like changelog and provider pinning before they bite.
• Markdown - paste it into issues, pull requests, or a runbook without any conversion step or extra tooling.
• Private - the whole flow runs in the browser; no data leaves your machine at any point in the process.
• Shareable - hand the checklist to a reviewer as evidence of release readiness before the tag is cut.
• Fast - generate a tailored checklist in seconds instead of writing one from scratch each release cycle.
• Repeatable - the same template means every module follows the identical publishing discipline over time.