Skip to content

feat: add standard Terraform files guide #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Gowiem
Copy link
Member

@Gowiem Gowiem commented Jun 5, 2025

Summary

  • Comprehensive guide covering standard Terraform file organization and best practices
  • Detailed explanation of core files: main.tf, variables.tf, outputs.tf, data.tf
  • Coverage of supporting files: providers.tf, versions.tf, .terraform.lock.hcl
  • Advanced patterns including checks.tf, imports.tf, and context.tf
  • Best practices for locals placement and file organization guidance

Test plan

  • Blog post passes trunk check formatting requirements
  • All internal links verified and working
  • Content follows existing blog post structure and style
  • Review content for accuracy and clarity
  • Verify all code examples are properly formatted

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • Added a comprehensive blog post, "The Standard Terraform and OpenTofu Files + Their Uses," providing an in-depth guide on organizing and using standard Terraform and OpenTofu files, including best practices, advanced usage patterns, and practical examples for improved Infrastructure as Code management.

- Detailed explanation of core files: main.tf, variables.tf, outputs.tf, data.tf
- Coverage of supporting files: providers.tf, versions.tf, .terraform.lock.hcl
- Advanced patterns including checks.tf, imports.tf, and context.tf
- Best practices for locals placement and file organization
- Guidance on avoiding "terralith" anti-patterns

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link

netlify bot commented Jun 5, 2025

Deploy Preview for masterpoint ready!

Name Link
🔨 Latest commit 217b338
🔍 Latest deploy log https://app.netlify.com/projects/masterpoint/deploys/68425766ee42a70008d1f763
😎 Deploy Preview https://deploy-preview-64--masterpoint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 35
Accessibility: 89
Best Practices: 75
SEO: 80
PWA: 70
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • static/img/updates/standard-tf-files.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new blog post titled "The Standard Terraform and OpenTofu Files + Their Uses" has been added. The post provides an in-depth guide on organizing and using standard Terraform and OpenTofu project files, covering file purposes, best practices, advanced usage, and practical examples.

Changes

File(s) Change Summary
content/blog/standard-tf-files.md Added a comprehensive blog post detailing standard Terraform/OpenTofu file organization, usage, and best practices.

Suggested reviewers

  • gberenice
  • oycyc

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
content/blog/standard-terraform-files-their-uses.md (2)

11-15: Strengthen word choice and clarity.
Replace “completely different” with “entirely different” and consider using “comprise” instead of “make up” to elevate the prose.

- you've definitely seen this problem: everyone organizes their TF files differently. Some teams jam everything into a single main.tf file, while others scatter resources across dozens of specialized files. This isn't just an aesthetic issue — it creates real headaches when you're trying to understand or fix infrastructure code.
+ you've definitely seen this problem: everyone organizes their TF files differently. Some teams jam everything into a single main.tf file, while others scatter resources across dozens of specialized files. This isn't just an aesthetic issue — it creates real headaches when you're trying to understand or fix infrastructure code.
...
- different contributors frequently follow completely different organizational patterns, creating a confusing patchwork that slows everyone down.
+ different contributors frequently follow entirely different organizational patterns, creating a confusing patchwork that slows everyone down.
...
- When the files that make up a TF project have standard names, locations and meanings, you know exactly where to look when something needs changing.
+ When the files that comprise a TF project have standard names, locations, and meanings, you know exactly where to look when something needs changing.
🧰 Tools
🪛 LanguageTool

[style] ~13-~13: Consider using a different adverb to strengthen your wording.
Context: ...ifferent contributors frequently follow completely different organizational patterns, crea...

(COMPLETELY_ENTIRELY)


[style] ~15-~15: Try using a synonym here to elevate your writing.
Context: ...nd troubleshooting. When the files that make up a TF project have standard names, locat...

(CONSTITUTE_COMPRISE)


23-23: Fix comma usage and spacing.
Add a comma before “but” and a space after the closing parenthesis for readability.

- (it doesn't technically need to be named main.tf but that is the industry convention).This file
+ (it doesn't technically need to be named main.tf, but that is the industry convention). This file
🧰 Tools
🪛 LanguageTool

[uncategorized] ~23-~23: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 101c152 and 5fa9904.

📒 Files selected for processing (1)
  • content/blog/standard-terraform-files-their-uses.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/standard-terraform-files-their-uses.md

[style] ~13-~13: Consider using a different adverb to strengthen your wording.
Context: ...ifferent contributors frequently follow completely different organizational patterns, crea...

(COMPLETELY_ENTIRELY)


[style] ~15-~15: Try using a synonym here to elevate your writing.
Context: ...nd troubleshooting. When the files that make up a TF project have standard names, locat...

(CONSTITUTE_COMPRISE)


[uncategorized] ~23-~23: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)


[uncategorized] ~110-~110: Possible missing comma found.
Context: ...llows consumers to upgrade on their own timeline rather than having their infrastructure...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~142-~142: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... always the most practical approach for very simple cases. For instance, if a module uses o...

(EN_WEAK_ADJECTIVE)


[grammar] ~146-~146: Do not use the singular ‘an’ before the plural noun ‘checks’.
Context: ...ndards-driven TF project often includes an optional checks.tf file that centralizes your validatio...

(VB_A_JJ_NNS)


[misspelling] ~169-~169: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...that root module. Here's an example of a imports.tf file: ```hcl # Example in i...

(EN_A_VS_AN)


[grammar] ~184-~184: Do not use the singular ‘a’ before the plural noun ‘imports’.
Context: ...The IAM role's name in AWS } ``` Using a distinct imports.tf file immediately clarifies which par...

(VB_A_JJ_NNS)


[uncategorized] ~244-~244: Possible missing comma found.
Context: ...configuration runs with a compatible TF version and fails if none are available. This p...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~253-~253: Possible missing comma found.
Context: ...operator allows patch and minor version updates while preventing major version changes ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~257-~257: Possible missing comma found.
Context: ...cross environments. Unlike the previous files which you create manually, TF automatic...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~282-~282: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...y, the lock file guarantees they'll use exactly the same provider versions during local developm...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[grammar] ~284-~284: The verb ‘terraform’ does not usually follow articles like ‘the’. Check that ‘terraform’ is spelled correctly; using ‘terraform’ as a noun may be non-standard.
Context: ... to update providers to newer versions, the terraform init -upgrade command will refresh the ...

(A_INFINITIVE)


[typographical] ~300-~300: Consider adding a comma after ‘technically’ for more clarity.
Context: ...y assigning names to expressions. While technically you can place locals anywhere, followin...

(RB_LY_COMMA)


[uncategorized] ~391-~391: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...en extensively on the null-label pattern and we'd encourage you to adopt this to imp...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~391-~391: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ... more about utilizing context.tf in our follow up advanced post](/blog/terraform-null-lab...

(VERB_NOUN_CONFUSION)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - masterpoint
  • GitHub Check: Header rules - masterpoint
  • GitHub Check: Pages changed - masterpoint
🔇 Additional comments (3)
content/blog/standard-terraform-files-their-uses.md (3)

1-9: Ensure frontmatter aligns with other posts.
Check that the YAML frontmatter includes all required fields (e.g., tags, categories) to match existing blog templates, and verify that the image path exists and follows naming conventions.

Please confirm that this frontmatter matches the site’s standard metadata template and that /img/updates/terraform-files-organization.png is present in the repo.


29-30: Verify internal links.
Ensure that all internal links (e.g., /blog/terralith-monolithic-terraform-architecture/, /blog/terraform-null-label/, /blog/terraform-null-label-advanced/, /contact/) are valid and resolve correctly on the live site.

You can run a link checker against the built site or manually confirm each target exists.


33-46: Confirm HCL code block syntax.
The Terraform examples should consistently use ```hcl fences and be properly closed. These code blocks look well-formed.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
content/blog/standard-tf-files.md (4)

12-15: Refine adverb usage

Consider replacing “completely” in “creating a confusing patchwork” with a stronger alternative like “entirely” or “wholly” to avoid redundancy.

🧰 Tools
🪛 LanguageTool

[style] ~14-~14: Consider using a different adverb to strengthen your wording.
Context: ...ifferent contributors frequently follow completely different organizational patterns, crea...

(COMPLETELY_ENTIRELY)


24-24: Punctuation fixes

Add a comma before “but” in “named main.tf, but” and insert a space after the closing parenthesis so it reads “…convention). This file defines…”

🧰 Tools
🪛 LanguageTool

[uncategorized] ~24-~24: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)


128-141: Reduce intensifier

Consider removing “very” in “very simple cases” to strengthen the guidance.


391-393: Fix minor punctuation

Hyphenate “follow up advanced post” to “follow-up advanced post” and consider adding a comma before “and we’d encourage you” for clarity.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~392-~392: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...en extensively on the null-label pattern and we'd encourage you to adopt this to imp...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~392-~392: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ... more about utilizing context.tf in our follow up advanced post](/blog/terraform-null-lab...

(VERB_NOUN_CONFUSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5fa9904 and 0248202.

⛔ Files ignored due to path filters (1)
  • static/img/updates/standard-tf-files.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • content/blog/standard-tf-files.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/standard-tf-files.md

[style] ~14-~14: Consider using a different adverb to strengthen your wording.
Context: ...ifferent contributors frequently follow completely different organizational patterns, crea...

(COMPLETELY_ENTIRELY)


[style] ~16-~16: Try using a synonym here to elevate your writing.
Context: ...nd troubleshooting. When the files that make up a TF project have standard names, locat...

(CONSTITUTE_COMPRISE)


[uncategorized] ~24-~24: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)


[uncategorized] ~111-~111: Possible missing comma found.
Context: ...llows consumers to upgrade on their own timeline rather than having their infrastructure...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~143-~143: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... always the most practical approach for very simple cases. For instance, if a module uses o...

(EN_WEAK_ADJECTIVE)


[grammar] ~147-~147: Do not use the singular ‘an’ before the plural noun ‘checks’.
Context: ...ndards-driven TF project often includes an optional checks.tf file that centralizes your validatio...

(VB_A_JJ_NNS)


[misspelling] ~170-~170: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...that root module. Here's an example of a imports.tf file: ```hcl # Example in i...

(EN_A_VS_AN)


[grammar] ~185-~185: Do not use the singular ‘a’ before the plural noun ‘imports’.
Context: ...The IAM role's name in AWS } ``` Using a distinct imports.tf file immediately clarifies which par...

(VB_A_JJ_NNS)


[uncategorized] ~245-~245: Possible missing comma found.
Context: ...configuration runs with a compatible TF version and fails if none are available. This p...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~254-~254: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ning principles. The ~> operator allows patch and minor version updates while prevent...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)


[uncategorized] ~254-~254: Possible missing comma found.
Context: ...operator allows patch and minor version updates while preventing major version changes ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~258-~258: Possible missing comma found.
Context: ...cross environments. Unlike the previous files which you create manually, TF automatic...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~283-~283: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...y, the lock file guarantees they'll use exactly the same provider versions during local developm...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[grammar] ~285-~285: The verb ‘terraform’ does not usually follow articles like ‘the’. Check that ‘terraform’ is spelled correctly; using ‘terraform’ as a noun may be non-standard.
Context: ... to update providers to newer versions, the terraform init -upgrade command will refresh the ...

(A_INFINITIVE)


[typographical] ~301-~301: Consider adding a comma after ‘technically’ for more clarity.
Context: ...y assigning names to expressions. While technically you can place locals anywhere, followin...

(RB_LY_COMMA)


[uncategorized] ~392-~392: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...en extensively on the null-label pattern and we'd encourage you to adopt this to imp...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~392-~392: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ... more about utilizing context.tf in our follow up advanced post](/blog/terraform-null-lab...

(VERB_NOUN_CONFUSION)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - masterpoint
  • GitHub Check: Header rules - masterpoint
  • GitHub Check: Pages changed - masterpoint
🔇 Additional comments (14)
content/blog/standard-tf-files.md (14)

1-10: Frontmatter Validity Check

The YAML frontmatter is well-formed and contains all required fields for the new blog post.


30-31: Confirm internal link

Please verify that the referenced post /blog/terralith-monolithic-terraform-architecture/ exists and the URL is correct.


61-74: Variables.tf example is clear

The HCL snippet correctly demonstrates declaring variables with descriptions, types, defaults, and validation rules.


91-104: Outputs.tf snippet is accurate

The example shows descriptive output blocks with clear naming conventions and helpful descriptions.


154-160: Checks.tf example is sound

The HCL snippet accurately demonstrates resource-level validation using Terraform’s check blocks.


172-183: Imports.tf example is clear

The import block examples correctly illustrate how to declare imports in Terraform v1.5+.


197-210: Providers.tf example is correct

The HCL fragment properly shows provider configurations, including aliased providers for multi‐region setups.


229-241: Versions.tf snippet is accurate

The example correctly demonstrates specifying Terraform and provider version constraints using semantic versioning.


263-275: Lock file example is valid

The .terraform.lock.hcl snippet properly shows provider blocks with version constraints and cryptographic hashes.


289-291: Multi-platform lock command is correct

The bash snippet for terraform providers lock across multiple platforms is accurate and clear.


308-316: Locals usage example is appropriate

The locals block snippet cleanly demonstrates deriving and grouping computed values.


330-336: Directory structure example is clear

The tree layout succinctly illustrates when and how to split .tf files by logical component.


353-363: Context.tf example is well-formatted

The snippet effectively shows using the null-label module for standardized metadata and tagging.


371-381: Context pattern usage is accurate

The HCL fragment demonstrates how provider-level default tags combine with module.this.tags.

…files guide

- Fixed inconsistent indentation in all HCL code snippets
- Properly aligned arguments in variable, output, and resource blocks
- Improved readability of for expressions and validation blocks
- All code examples now follow consistent Terraform formatting standards
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
content/blog/standard-tf-files.md (4)

25-26: Add missing comma and space in parentheses.

Add a comma before but inside the parenthetical and ensure a space follows the closing parenthesis:

-Every TF project needs a main file (it doesn't technically need to be named main.tf but that is the industry convention).This main file defines...
+Every TF project needs a main file (it doesn't technically need to be named main.tf, but that is the industry convention). This main file defines...
🧰 Tools
🪛 LanguageTool

[uncategorized] ~25-~25: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)


170-178: Use 'an' before 'imports.tf' for vowel sound.

Since imports.tf file begins with a vowel sound, change the article from a to an:

-Using a imports.tf file
+Using an imports.tf file
🧰 Tools
🪛 LanguageTool

[misspelling] ~174-~174: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...that root module. Here's an example of a imports.tf file: ```hcl # Example in i...

(EN_A_VS_AN)


285-289: Wrap CLI command in backticks and adjust article.

For consistency and clarity, format the Terraform command in backticks and remove the extraneous article:

-…to update providers to newer versions, the terraform init -upgrade command will refresh…
+…to update providers to newer versions, `terraform init -upgrade` will refresh…
🧰 Tools
🪛 LanguageTool

[style] ~287-~287: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...y, the lock file guarantees they'll use exactly the same provider versions during local developm...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[grammar] ~289-~289: The verb ‘terraform’ does not usually follow articles like ‘the’. Check that ‘terraform’ is spelled correctly; using ‘terraform’ as a noun may be non-standard.
Context: ... to update providers to newer versions, the terraform init -upgrade command will refresh the ...

(A_INFINITIVE)


396-400: Hyphenate 'follow-up' and add comma before 'and'.

Update the phrase to use a hyphen and include a comma for compound sentence correctness:

-](/blog/terraform-null-label/) and [read more about utilizing context.tf in our follow up advanced post…
+](/blog/terraform-null-label/), and [read more about utilizing context.tf in our follow-up advanced post…
🧰 Tools
🪛 LanguageTool

[uncategorized] ~399-~399: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...en extensively on the null-label pattern and we'd encourage you to adopt this to imp...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~399-~399: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ... more about utilizing context.tf in our follow up advanced post](/blog/terraform-null-lab...

(VERB_NOUN_CONFUSION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0248202 and 6d8c690.

📒 Files selected for processing (1)
  • content/blog/standard-tf-files.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/blog/standard-tf-files.md

[style] ~15-~15: Consider using a different adverb to strengthen your wording.
Context: ...ifferent contributors frequently follow completely different organizational patterns, crea...

(COMPLETELY_ENTIRELY)


[style] ~17-~17: Try using a synonym here to elevate your writing.
Context: ...nd troubleshooting. When the files that make up a TF project have standard names, locat...

(CONSTITUTE_COMPRISE)


[uncategorized] ~25-~25: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)


[uncategorized] ~112-~112: Possible missing comma found.
Context: ...llows consumers to upgrade on their own timeline rather than having their infrastructure...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~144-~144: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... always the most practical approach for very simple cases. For instance, if a module uses o...

(EN_WEAK_ADJECTIVE)


[grammar] ~148-~148: Do not use the singular ‘an’ before the plural noun ‘checks’.
Context: ...ndards-driven TF project often includes an optional checks.tf file that centralizes your validatio...

(VB_A_JJ_NNS)


[misspelling] ~174-~174: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...that root module. Here's an example of a imports.tf file: ```hcl # Example in i...

(EN_A_VS_AN)


[grammar] ~189-~189: Do not use the singular ‘a’ before the plural noun ‘imports’.
Context: ...The IAM role's name in AWS } ``` Using a distinct imports.tf file immediately clarifies which par...

(VB_A_JJ_NNS)


[uncategorized] ~249-~249: Possible missing comma found.
Context: ...configuration runs with a compatible TF version and fails if none are available. This p...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~258-~258: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ning principles. The ~> operator allows patch and minor version updates while prevent...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)


[uncategorized] ~258-~258: Possible missing comma found.
Context: ...operator allows patch and minor version updates while preventing major version changes ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~262-~262: Possible missing comma found.
Context: ...cross environments. Unlike the previous files which you create manually, TF automatic...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~287-~287: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...y, the lock file guarantees they'll use exactly the same provider versions during local developm...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[grammar] ~289-~289: The verb ‘terraform’ does not usually follow articles like ‘the’. Check that ‘terraform’ is spelled correctly; using ‘terraform’ as a noun may be non-standard.
Context: ... to update providers to newer versions, the terraform init -upgrade command will refresh the ...

(A_INFINITIVE)


[typographical] ~305-~305: Consider adding a comma after ‘technically’ for more clarity.
Context: ...y assigning names to expressions. While technically you can place locals anywhere, followin...

(RB_LY_COMMA)


[uncategorized] ~399-~399: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...en extensively on the null-label pattern and we'd encourage you to adopt this to imp...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~399-~399: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ... more about utilizing context.tf in our follow up advanced post](/blog/terraform-null-lab...

(VERB_NOUN_CONFUSION)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - masterpoint
  • GitHub Check: Header rules - masterpoint
  • GitHub Check: Pages changed - masterpoint
🔇 Additional comments (2)
content/blog/standard-tf-files.md (2)

1-11: Verify front matter compliance with blog schema.

Ensure that all required front matter fields (visible, draft, title, author, slug, date, etc.) adhere to the site's schema and formatting rules, and that the HTML in the callout renders correctly.


10-414: Verify internal and external link validity.

Please ensure that every internal reference (e.g., /blog/terralith-monolithic-terraform-architecture/, /contact/) and external URL resolves correctly without broken links.

🧰 Tools
🪛 LanguageTool

[style] ~15-~15: Consider using a different adverb to strengthen your wording.
Context: ...ifferent contributors frequently follow completely different organizational patterns, crea...

(COMPLETELY_ENTIRELY)


[style] ~17-~17: Try using a synonym here to elevate your writing.
Context: ...nd troubleshooting. When the files that make up a TF project have standard names, locat...

(CONSTITUTE_COMPRISE)


[uncategorized] ~25-~25: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n't technically need to be named main.tf but that is the industry convention).This f...

(COMMA_COMPOUND_SENTENCE_2)


[uncategorized] ~112-~112: Possible missing comma found.
Context: ...llows consumers to upgrade on their own timeline rather than having their infrastructure...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~144-~144: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... always the most practical approach for very simple cases. For instance, if a module uses o...

(EN_WEAK_ADJECTIVE)


[grammar] ~148-~148: Do not use the singular ‘an’ before the plural noun ‘checks’.
Context: ...ndards-driven TF project often includes an optional checks.tf file that centralizes your validatio...

(VB_A_JJ_NNS)


[misspelling] ~174-~174: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...that root module. Here's an example of a imports.tf file: ```hcl # Example in i...

(EN_A_VS_AN)


[grammar] ~189-~189: Do not use the singular ‘a’ before the plural noun ‘imports’.
Context: ...The IAM role's name in AWS } ``` Using a distinct imports.tf file immediately clarifies which par...

(VB_A_JJ_NNS)


[uncategorized] ~249-~249: Possible missing comma found.
Context: ...configuration runs with a compatible TF version and fails if none are available. This p...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~258-~258: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ning principles. The ~> operator allows patch and minor version updates while prevent...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)


[uncategorized] ~258-~258: Possible missing comma found.
Context: ...operator allows patch and minor version updates while preventing major version changes ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~262-~262: Possible missing comma found.
Context: ...cross environments. Unlike the previous files which you create manually, TF automatic...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~287-~287: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...y, the lock file guarantees they'll use exactly the same provider versions during local developm...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[grammar] ~289-~289: The verb ‘terraform’ does not usually follow articles like ‘the’. Check that ‘terraform’ is spelled correctly; using ‘terraform’ as a noun may be non-standard.
Context: ... to update providers to newer versions, the terraform init -upgrade command will refresh the ...

(A_INFINITIVE)


[typographical] ~305-~305: Consider adding a comma after ‘technically’ for more clarity.
Context: ...y assigning names to expressions. While technically you can place locals anywhere, followin...

(RB_LY_COMMA)


[uncategorized] ~399-~399: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...en extensively on the null-label pattern and we'd encourage you to adopt this to imp...

(COMMA_COMPOUND_SENTENCE)


[uncategorized] ~399-~399: When ‘follow-up’ is used as a noun or modifier, it needs to be hyphenated.
Context: ... more about utilizing context.tf in our follow up advanced post](/blog/terraform-null-lab...

(VERB_NOUN_CONFUSION)

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