Ensure input/output descriptions exist and consistent with README #34
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
Updates input and output descriptions throughout the Terraform module to ensure consistency with README documentation and improve clarity for users.
- Rewrote variable descriptions to be more descriptive and user-friendly
- Added missing descriptions for previously undocumented variables and outputs
- Clarified internal-use variables with "Internal:" prefix and "Do not override" warnings
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| variables.tf | Updated descriptions for tenant_name, __all_zones, and __athenz_env variables |
| outputs.tf | Enhanced descriptions for zones and enclave_config outputs with better formatting |
| modules/provision/variables.tf | Added missing description for template_version variable |
| modules/provision/main.tf | Added missing description for client_id output |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
gjoranv
force-pushed
the
output-descriptions
branch
2 times, most recently
from
de444ac to
b5ebbd3
Compare
hakonhall
approved these changes
Oct 20, 2025
gjoranv
added
no-tag
gjoranv
changed the title
hakonhall
approved these changes
Oct 20, 2025
gjoranv
changed the title
- Note that multi-line descriptions are not allowed neither by concatenation nor using join. Herdoc is allowed, but will split the actual strings shown in registries.
- Add comments for internal use.
gjoranv
force-pushed
the
output-descriptions
branch
from
572997b to
00dbdea
Compare
hakonhall
approved these changes
Oct 21, 2025
gjoranv
added
no-tag
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.