-
Notifications
You must be signed in to change notification settings - Fork 1
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
base: master
Are you sure you want to change the base?
Conversation
- 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]>
✅ Deploy Preview for masterpoint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughA 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
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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 theimage
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.
There was a problem hiding this 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 usageConsider 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 fixesAdd 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 intensifierConsider removing “very” in “very simple cases” to strengthen the guidance.
391-393
: Fix minor punctuationHyphenate “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
⛔ 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 CheckThe YAML frontmatter is well-formed and contains all required fields for the new blog post.
30-31
: Confirm internal linkPlease verify that the referenced post
/blog/terralith-monolithic-terraform-architecture/
exists and the URL is correct.
61-74
: Variables.tf example is clearThe HCL snippet correctly demonstrates declaring variables with descriptions, types, defaults, and validation rules.
91-104
: Outputs.tf snippet is accurateThe example shows descriptive output blocks with clear naming conventions and helpful descriptions.
154-160
: Checks.tf example is soundThe HCL snippet accurately demonstrates resource-level validation using Terraform’s
check
blocks.
172-183
: Imports.tf example is clearThe import block examples correctly illustrate how to declare imports in Terraform v1.5+.
197-210
: Providers.tf example is correctThe HCL fragment properly shows provider configurations, including aliased providers for multi‐region setups.
229-241
: Versions.tf snippet is accurateThe example correctly demonstrates specifying Terraform and provider version constraints using semantic versioning.
263-275
: Lock file example is validThe
.terraform.lock.hcl
snippet properly shows provider blocks with version constraints and cryptographic hashes.
289-291
: Multi-platform lock command is correctThe bash snippet for
terraform providers lock
across multiple platforms is accurate and clear.
308-316
: Locals usage example is appropriateThe
locals
block snippet cleanly demonstrates deriving and grouping computed values.
330-336
: Directory structure example is clearThe tree layout succinctly illustrates when and how to split
.tf
files by logical component.
353-363
: Context.tf example is well-formattedThe snippet effectively shows using the null-label module for standardized metadata and tagging.
371-381
: Context pattern usage is accurateThe 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
There was a problem hiding this 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 froma
toan
:-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
📒 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 thecallout
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)
Summary
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit