-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
terraform modules
cmd human view
#36062
base: main
Are you sure you want to change the base?
Conversation
0778f7a
to
2f7081c
Compare
2f7081c
to
272130e
Compare
terraform modules
cmd human view
The equivalence tests will be updated. Please verify the changes here. |
The equivalence tests will be updated. Please verify the changes here. |
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.
Looks great! Added a small opportunistic suggestion
272130e
to
4cba6bb
Compare
The equivalence tests will be updated. Please verify the changes here. |
4cba6bb
to
e4b4aa8
Compare
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.
Approved with some small tweaks for style!
The following example is a representation of the human readable output that `terraform modules` returns. The nested structure represents the | ||
module composition/heirarchy within your configuration. | ||
|
||
``` |
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.
Should this be shell? Or something like it? We wanna make sure we get syntax highlighting if we can!
``` | |
```shell-session |
|
||
We will introduce new major versions only within the bounds of | ||
[the Terraform 1.0 Compatibility Promises](/terraform/language/v1-compatibility-promises). | ||
|
||
## Output Format | ||
|
||
The following example is a representation of the human readable output that `terraform modules` returns. The nested structure represents the |
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.
I like putting the "what" first before diving into the example, but let me know what you think!
The following example is a representation of the human readable output that `terraform modules` returns. The nested structure represents the | |
The `terraform modules` command returns a nested structure, representing module composition and hierarchy within your configuration. | |
The following example demonstrates what the `terraform modules` command returns without any additional flags: |
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.
(make sure to remove the line below if you accept this suggestion!
Implements a human view for what was previously a machine readable view only command
terraform modules -json
. The human view shows the nested hierarchy/composition of modules in configuration rather than the flat list given by the json alternative, as well as additional info about the provided version constraints for the module. Documentation and the command's help output has been updated in accordance with this addition.To accommodate this nested format, some reworking of
resolver.go
has been done to produce a manifest with a nested structure of records (whereas before a flat list was given).Target Release
1.11.x
Draft CHANGELOG entry
NEW FEATURES
terraform modules
command.