Align variables

[brettcurtis]

Summary by CodeRabbit

• Documentation
  • Updated the Terraform module documentation for clarity, including changes to the environment variable description and provider version.
• Chores
  • Updated pre-commit hook repository versions to ensure the latest features and fixes.
• Refactor
  • Modified local variable constructions to improve project ID generation based on environment mapping.

[coderabbitai]

Warning

Rate limit exceeded

@brettcurtis has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9e5748c and 9b68ded.

Walkthrough

This pull request includes updates to several configuration files related to a Terraform project. The .pre-commit-config.yaml file has been modified to update the versions of specific pre-commit hooks. The README.md file has undergone changes to the documentation of the Terraform module, including a downgrade of the Google provider version and a refinement of the environment variable description. Additionally, the locals.tf and variables.tf files have been updated to change how local variables are defined and to modify the description and default value of the environment variable.

Changes

File	Change Summary
.pre-commit-config.yaml	Updated repository versions: antonbabenko/pre-commit-terraform from v1.96.1 to v1.96.2; bridgecrewio/checkov from 3.2.256 to 3.2.276.
README.md	Downgraded google provider version from 6.9.0 to 6.8.0; updated environment variable description for clarity.
locals.tf	Introduced env_map and env local variables; updated base_project_id and project_id to use local.env instead of var.environment.
variables.tf	Updated environment variable description and changed default value from "sb" to "sandbox".

Possibly related PRs

• Align to coding conventions #131: The changes in the .pre-commit-config.yaml file are directly related, as both PRs involve updates to the versions of the same repositories (antonbabenko/pre-commit-terraform and bridgecrewio/checkov) used for pre-commit hooks.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

variables.tf (1)

40-40: Consider adding migration notes to the description.

To help users migrate, consider enhancing the description with a migration note.

-  description = "The environment for example: `sandbox`, `non-production`, `production`"
+  description = "The environment for example: `sandbox`, `non-production`, `production`. Note: Previously used abbreviated values ('sb', 'nonprod', 'prod') should be updated to full names."

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f2547a1 and 9e5748c.

📒 Files selected for processing (4)

• .pre-commit-config.yaml (2 hunks)
• README.md (2 hunks)
• locals.tf (3 hunks)
• variables.tf (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• .pre-commit-config.yaml
• README.md

🔇 Additional comments (3)

variables.tf (1)

40-42: LGTM! But note this is a breaking change.

The shift from abbreviated environment names (sb) to full names (sandbox) improves clarity and maintainability. However, this change could impact existing configurations that rely on the abbreviated format.

Let's check for potential impacts:

locals.tf (2)

5-5: LGTM: Consistent environment naming approach

The change to use local.env instead of var.environment directly ensures consistent environment naming through the mapping system.

---

108-108: LGTM: Verify project ID format across environments

The change to use local.env is consistent with the new environment mapping approach.

Let's verify the project ID format across different environments:

#!/bin/bash
# Check for any hardcoded project IDs that might not follow the new format
rg -g '*.tf' '(project_id|project-id).*=.*-[a-z]+-[a-z]+$' 

# Check for any direct references to var.environment that should use local.env
rg -g '*.tf' 'var\.environment(?!.*validation)'