fix: pass github_enterprise.id to stacks

[Gowiem]

what

• Pass the github_enterprise.id value to the github_enterprise block

why

• This is needed so consumers can provide both namespace and id for the github_enterprise config

references

• Internal Slack Thread

Summary by CodeRabbit

• New Features

  • Introduced a new attribute for GitHub Enterprise integration, allowing for the specification of an ID.

• Bug Fixes

  • Added a precondition to ensure the required configuration file is present before stack creation, improving error handling.

• Documentation

  • Clarified the use of the deactivated attribute in the spacelift_stack_destructor resource to prevent unintended toggling.

[coderabbitai]

Walkthrough

The pull request modifies the Terraform configuration for Spacelift stacks, focusing on two primary enhancements. First, a new id attribute is introduced in the github_enterprise dynamic block of the spacelift_stack resource to improve GitHub Enterprise integration. Second, a lifecycle precondition is added to validate the presence of a .tfvars file before stack creation, ensuring robust error handling and configuration validation.

Changes

File	Change Summary
main.tf	- Added id attribute in github_enterprise dynamic block - Introduced lifecycle precondition to check .tfvars file existence - Clarified spacelift_stack_destructor resource usage

Sequence Diagram

sequenceDiagram
    participant Terraform
    participant SpaceliftStack
    participant GitHubEnterprise
    
    Terraform->>SpaceliftStack: Create Stack
    SpaceliftStack-->>Terraform: Validate .tfvars
    Terraform->>GitHubEnterprise: Retrieve Enterprise ID
    GitHubEnterprise-->>SpaceliftStack: Return Enterprise ID
    SpaceliftStack->>Terraform: Stack Creation Confirmed

Loading

Possibly Related PRs

• fix: support TF default workspace, more attributes + fix drift detection schedule #11: Adds complementary attributes enable_well_known_secret_masking and github_action_deploy to the Spacelift stack resource, indicating ongoing configuration improvements

Poem

🚀 Terraform's dance of config and might,
Where stacks rise with validation's light,
GitHub's ID now clear and bright,
Preconditions keeping errors tight,
A symphony of infrastructure's delight! 🛡️

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 anywhere in the PR title to generate the title automatically.

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: 0

🧹 Nitpick comments (1)

main.tf (1)

272-277: Consider updating documentation for github_enterprise configuration

While the implementation is correct, it would be helpful to add a comment block above the github_enterprise dynamic block explaining the expected structure of the var.github_enterprise variable and its usage.

Add documentation like this:

+  # GitHub Enterprise configuration
+  # Expects a map with 'namespace' and 'id' keys to configure GitHub Enterprise integration
+  # Example:
+  # github_enterprise = {
+  #   namespace = "my-org"
+  #   id        = "12345"
+  # }
   dynamic "github_enterprise" {
     for_each = var.github_enterprise != null ? [var.github_enterprise] : []
     content {
       namespace = github_enterprise.value["namespace"]
       id        = github_enterprise.value["id"]
     }
   }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93c6498 and e57d20e.

📒 Files selected for processing (1)

• main.tf (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

main.tf (1)

Pattern **/*.tf: You're a Terraform expert who has thoroughly studied all the documentation from Hashicorp https://developer.hashicorp.com/terraform/docs and OpenTofu https://opentofu.org/docs/.
You have a strong grasp of Terraform syntax and prioritize providing accurate and insightful code suggestions.
As a fan of the Cloud Posse / SweetOps ecosystem, you incorporate many of their best practices https://docs.cloudposse.com/best-practices/terraform/ while balancing them with general Terraform guidelines.

🔇 Additional comments (1)

main.tf (1)

275-275: LGTM! Addition of github_enterprise.id aligns with requirements

The implementation correctly adds the id attribute to the github_enterprise block, enabling consumers to specify both namespace and id for GitHub Enterprise configuration.

Let's verify the variable definition and any potential usage:

✅ Verification successful

✅ Variable definition and usage are properly aligned

The verification confirms:

• The github_enterprise variable is correctly defined with an optional id field in both the module and example
• The dynamic block implementation properly references the variable fields
• Usage in the example demonstrates correct variable passing

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify github_enterprise variable definition and usage

# Check for variable definition
rg -A 5 'variable "github_enterprise"'

# Check for any other references to github_enterprise
rg 'github_enterprise' --type tf

Length of output: 1319

[gberenice]

Doh!