docs: update version number in example on readme

[westonplatter]

what

why

• Bring copy/paste example to do date with module versions published on TF registries.

Summary by CodeRabbit

• Documentation
  • Refreshed Terraform usage examples with improved formatting and alignment for readability.
  • Updated the ssm-agent example to reference the latest major version (1.8.0) and clarified field ordering.
  • Adjusted the dynamic-subnets example indentation and spacing without changing behavior.
  • Enhancements make copy-paste setup clearer and reduce confusion around versioning and configuration layout.

[coderabbitai]

Walkthrough

The README updates Terraform usage examples. In the ssm-agent module block, the example bumps the version from 0.15.1 to 1.8.0, reorders fields (namespace, stage), and adjusts alignment/spacing. In the dynamic-subnets module block, the version remains 2.3.0; indentation and spacing are adjusted, and a blank line is added. No code or exported/public declarations are changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs: update readme update after releasing v0.1.0 terraform-postgres-config-dbs-users-roles#7 — Also updates Terraform README module usage (source/version/formatting), indicating similar documentation adjustments.

Suggested reviewers

• oycyc

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly indicates that the documentation examples in the README have been updated to reflect a new module version, which matches the core change in this pull request.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/aws-auto-scaling-tags

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65ee015 and c0a83ca.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: gberenice
PR: masterpointio/terraform-aws-tailscale#41
File: main.tf:0-0
Timestamp: 2024-11-21T13:30:01.588Z
Learning: In this Terraform module (`main.tf`), read permissions (`ssm:GetParameter`) for SSM parameters are managed by the SSM Agent module (`masterpointio/ssm-agent/aws`), so adding `ssm:GetParameter` permissions in the custom `ssm_policy` module is unnecessary.

📚 Learning: 2024-11-21T13:30:01.588Z

Learnt from: gberenice
PR: masterpointio/terraform-aws-tailscale#41
File: main.tf:0-0
Timestamp: 2024-11-21T13:30:01.588Z
Learning: In this Terraform module (`main.tf`), read permissions (`ssm:GetParameter`) for SSM parameters are managed by the SSM Agent module (`masterpointio/ssm-agent/aws`), so adding `ssm:GetParameter` permissions in the custom `ssm_policy` module is unnecessary.

Applied to files:

• README.md

🔇 Additional comments (1)

README.md (1)

33-37: Confirm Terraform Registry module version Ensure masterpointio/ssm-agent/aws v1.8.0 exists on the Terraform Registry; if it isn’t released yet, the copy-/paste example will break.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[oycyc]

I wonder if it makes sense to put something like "x.x.x" so it suggests to the consumer to take the latest version and pin it. CloudPosse does this (https://github.com/cloudposse/terraform-aws-s3-bucket) and we do as well in the Tailscale module (https://github.com/masterpointio/terraform-aws-tailscale/)

[westonplatter]

Yeah, I think x.x.x is a better solution to encourage/force users to look up the version numbers.

[oycyc]

👍