Read leading module header from main.tf #154
Merged
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.
Prerequisites
Put an
x
into the box(es) that apply:For more information, see the Contributing Guide.
Description
As part of preparing the support for Terraform 0.12 which has been discussed in length (#62 (comment), #62 (comment) and hashicorp/terraform-config-inspect#21 (comment)) we had decided to drop the support of extracting module header comment from
main.tf
file, but this PR is going to address it with minimal effort, which is internal toterraform-docs
codebase and does not depend on Terraform community as a whole andterraform-config-inspect
in particular.Supported comment formats is:
/** **/
BREAKING CHANGE:
header
.Issues Resolved
Fixes #146
Checklist
Put an
x
into all boxes that apply:Tests
make test
.Documentation
Code Style