Skip to content

docs(terraform): use placeholder buckets in AWS and GCP dev backend examples - #502

Merged
cristim merged 2 commits into
mainfrom
fix/481-aws-dev-backend-example
Oct 5, 2026
Merged

cristim merged 2 commits into
mainfrom
fix/481-aws-dev-backend-example

Conversation

@cristim

@cristim cristim commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Summary

Replace the wrong-account bucket in aws/backends/dev.tfbackend.example with a placeholder, and do the same for the GCP dev example and README.

Why

cudly-terraform-state-dev is in AWS account 540659244915, not the deploy account 909626172446. Copying the example for a local terraform init would hit the wrong account's bucket. The repo is public, and the sibling generic tfbackend.example files already use your-... placeholders, so a placeholder is the consistent choice (unlike ci-cd-permissions/backend.hcl.example, which only the owner runs and which #478 pointed at the real bucket).

Change

  • AWS dev example: bucket your-cudly-terraform-state-aws-dev, key github-dev/terraform.tfstate (same shape CI writes), comment that CI uses the TF_BACKEND_AWS secret.
  • GCP dev example and gcp/README.md: cudly-terraform-state-dev is neither a placeholder nor the CI bucket, so it becomes your-cudly-terraform-state-gcp-dev.
  • No other doc referenced the AWS bucket or key.

Verification

terraform fmt -check clean; grep shows no remaining cudly-terraform-state-dev. No plan/apply run.

Closes #481

Summary by CodeRabbit

  • Documentation
    • Updated the AWS and GCP development setup examples with distinct, environment-specific Terraform state bucket names.
    • Clarified that CI obtains its AWS backend configuration from the TF_BACKEND_AWS secret.
    • Updated the AWS state key example; other backend settings remain unchanged.

…xamples

The AWS dev example named a bucket in another account; the GCP dev example and README named a bucket that is neither a placeholder nor the CI bucket. Closes #481
@cristim cristim added impact/internal Team-internal only triaged Item has been triaged priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline effort/xs Trivial / one-liner type/bug Defect labels Oct 5, 2026
@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

  • Run on-demand review

This review includes 1 billable file and costs up to $0.25.

  • Ask an admin to make reviews automatic

Open in CodeRabbit

Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing.

Or wait 50 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available. Your 52 included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: LeanerCloud/cloud-commitments-platform/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: f5befca2-7849-4ad0-912b-883616d686a5
📥 Commits

Reviewing files that changed from the base of the PR and between 5d65dd6 and 58e340d.

📒 Files selected for processing (1)
  • terraform/environments/gcp/backends/dev.tfbackend.example

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: LeanerCloud/cloud-commitments-platform/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 324c8e18-5fea-48df-96fd-1e47344aa0cc
📥 Commits

Reviewing files that changed from the base of the PR and between ce7aa68 and 5d65dd6.

📒 Files selected for processing (3)
  • terraform/environments/aws/backends/dev.tfbackend.example
  • terraform/environments/gcp/README.md
  • terraform/environments/gcp/backends/dev.tfbackend.example

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.


📝 Walkthrough

Walkthrough

The AWS and GCP development backend examples now use provider-specific bucket names. The AWS example also updates its state key and identifies the TF_BACKEND_AWS secret as CI’s backend source. The GCP README uses the updated GCP bucket name.

Changes

Development backend examples

Layer / File(s) Summary
AWS backend example
terraform/environments/aws/backends/dev.tfbackend.example
The example uses your-cudly-terraform-state-aws-dev and the github-dev/terraform.tfstate key. It notes that CI builds its backend from the TF_BACKEND_AWS secret.
GCP backend example and documentation
terraform/environments/gcp/backends/dev.tfbackend.example, terraform/environments/gcp/README.md
The example and README use your-cudly-terraform-state-gcp-dev. The example keeps the dev prefix.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other · Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to 5d65d

The changes do not alter CI’s AWS backend path, and the GCP setup documents creating the bucket used by its example. No demonstrated issue blocks merging.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: using placeholder bucket names in the AWS and GCP development backend examples.
Linked Issues check ✅ Passed Issue #481 allows an obvious placeholder instead of the wrong AWS bucket. The AWS example now uses your-cudly-terraform-state-aws-dev, sets github-dev/terraform.tfstate, and states that CI builds …
Out of Scope Changes check ✅ Passed All changes address issue #481: they replace ambiguous development bucket names in the backend examples and GCP setup instructions, and clarify that CI uses the AWS secret rather than the local exampl…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cristim
cristim merged commit d636276 into main Oct 5, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/xs Trivial / one-liner impact/internal Team-internal only priority/p3 Polish / idea / may never ship severity/low Minor harm triaged Item has been triaged type/bug Defect urgency/eventually No deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(aws): dev.tfbackend.example names a bucket in the wrong AWS account

1 participant