Test TF docs change#3
Conversation
HumanitecBot
assigned
agnesk92,
delca85,
docktorrr,
louisbennett,
mateuszjenek,
Nilsty and
TobiasBabin
HumanitecBot
requested review from
Nilsty,
agnesk92,
delca85,
docktorrr,
louisbennett and
mateuszjenek
There was a problem hiding this comment.
Pull request overview
Updates Terraform provider version constraints in versions.tf, affecting how provider versions are selected during terraform init.
Changes:
- Relax AWS provider constraint from
~> 6.0to>= 6.0 - Relax Random provider constraint from
~> 3.0to>= 3.0
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (1)
README.md:812
- This repo adds terraform-docs config to hide the Providers section, but the generated docs block in README still includes a Providers section. Please re-run terraform-docs generation so the README matches the new config (or drop the config if providers should remain visible).
## Modules
No modules.
## Resources
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sections: | ||
| hide: | ||
| - providers No newline at end of file |
There was a problem hiding this comment.
terraform-docs only auto-discovers config when it is named .terraform-docs.yml/.terraform-docs.yaml at the repository root; .github/terraform-docs.yml will be ignored unless the workflow passes it via --config. Consider renaming/moving to the default filename/location or ensure the CI workflow explicitly points terraform-docs to this file.
HumanitecBot
requested review from
Nilsty,
agnesk92,
delca85,
docktorrr,
louisbennett and
mateuszjenek
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| source = "hashicorp/aws" | ||
| version = "~> 6.0" | ||
| version = ">= 6.0" | ||
| } | ||
| random = { | ||
| source = "hashicorp/random" | ||
| version = "~> 3.0" | ||
| version = ">= 3.0" | ||
| } |
There was a problem hiding this comment.
The provider constraints are now open-ended (e.g., >= 6.0), which allows future major versions (like 7.x) that may introduce breaking changes and unexpectedly break module consumers. Consider constraining to the current major series (e.g., >= 6.0, < 7.0 or keeping ~> 6.0) unless you explicitly support and test newer majors.
| # Do not show providers. | ||
| # The versions that will be rendered into this block provide a snapshot only | ||
| # based on the version constraints in the "required_providers" block | ||
| # but are not useful information for module users. | ||
| sections: | ||
| hide: | ||
| - providers No newline at end of file |
There was a problem hiding this comment.
terraform-docs does not auto-detect configuration files from .github/terraform-docs.yml by default; it only auto-loads .terraform-docs.yml (and a few specific search locations) unless your workflow passes --config explicitly. As-is, CI/docs generation may ignore this file and regenerate README with the Providers section included. Either move/rename this to .terraform-docs.yml in the module root (or supported config path) or ensure the reusable workflow invokes terraform-docs with --config .github/terraform-docs.yml.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # The versions that will be rendered into this block provide a snapshot only | ||
| # based on the version constraints in the "required_providers" block | ||
| # but are not useful information for module users. | ||
| sections: |
There was a problem hiding this comment.
There’s a stray # foo comment in this terraform-docs configuration. It looks like leftover debug text and should be removed to keep repo configuration clean and intentional.
|
Closing once more with testing finished. |
TobiasBabin
removed request for
Nilsty,
agnesk92,
delca85,
docktorrr,
louisbennett and
mateuszjenek
TobiasBabin
unassigned
louisbennett,
delca85,
docktorrr,
Nilsty,
mateuszjenek,
agnesk92 and
TobiasBabin
No description provided.