Skip to content

docs(migration-to-aws): document tf-best-practices skill in plugin README#143

Merged
icarthick merged 1 commit into
awslabs:mainfrom
icarthick:docs/tf-best-practices-readme
Jul 15, 2026
Merged

docs(migration-to-aws): document tf-best-practices skill in plugin README#143
icarthick merged 1 commit into
awslabs:mainfrom
icarthick:docs/tf-best-practices-readme

Conversation

@icarthick

Copy link
Copy Markdown
Collaborator

Summary

Follow-up to #142 (which added the tf-best-practices policy gate but did not touch the plugin README). Documents the skill in migrate/plugins/migration-to-aws/README.md.

The tf-best-practices skill is a read-only Terraform security policy gate. gcp-to-aws consumes it during Generate, but it's self-contained — a zero-dependency static HCL reader with no dependency on the migration workflow — so it's also directly usable standalone.

Changes

  • New tf-best-practices section (parallel to the existing llm-to-bedrock section) describing what it enforces and, importantly, how to run it standalone as a pre-commit/CI check:
    python3 skills/tf-best-practices/scripts/validate-terraform-policy.py ./terraform --json verdict.json
    with exit-code semantics (0 = POLICY_OK, 1 = POLICY_FAIL, 2 = usage) and the --json verdict shape (file/line/rule/fix_hint).
  • Adds a scope note that gcp-to-aws is the only in-tree consumer today (standalone use is supported but not yet wired into other skills) — matching the SKILL.md "Consumers (v1)" contract.
  • Updates the Plugins table capability row to mention the policy gate.

Docs-only; no code changes. mise build passes locally.

…ADME

Adds a tf-best-practices section (parallel to llm-to-bedrock) describing it as
a read-only Terraform security policy gate that gcp-to-aws consumes during
Generate but which is self-contained and directly usable standalone. Includes
the standalone script invocation (exit codes + --json verdict shape) for
pre-commit/CI use, and a scope note that gcp-to-aws is the only in-tree consumer
today. Also updates the plugin capability row in the Plugins table.
@icarthick
icarthick requested a review from a team as a code owner July 15, 2026 17:58
@icarthick
icarthick merged commit eacdfe1 into awslabs:main Jul 15, 2026
8 checks passed
@icarthick
icarthick deleted the docs/tf-best-practices-readme branch July 16, 2026 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant