Skip to content
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

Read leading module header from main.tf #154

Merged
merged 1 commit into from
Jan 10, 2020

Conversation

khos2ow
Copy link
Member

@khos2ow khos2ow commented Jan 10, 2020

Prerequisites

Put an x into the box(es) that apply:

  • This pull request fixes a bug.
  • This pull request adds a feature.
  • This pull request enhances existing functionality.
  • This pull request introduces breaking change.

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 to terraform-docs codebase and does not depend on Terraform community as a whole and terraform-config-inspect in particular.

Supported comment formats is:

  • jsdoc, c or java-like multi-line comment /** **/

BREAKING CHANGE:

  • In the JSON format respone, module "Comment" has been renamed to module header.

Issues Resolved

Fixes #146

Checklist

Put an x into all boxes that apply:

Tests

  • I have added tests to cover my changes.
  • All tests pass when I run make test.

Documentation

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Code Style

  • My code follows the code style of this project.

Supported comment formats is:

- jsdoc, c or java-like multi-line comment `/** **/`
@khos2ow khos2ow added the bug label Jan 10, 2020
@khos2ow khos2ow added this to the v0.8.0 milestone Jan 10, 2020
@khos2ow khos2ow merged commit b3112d1 into terraform-docs:master Jan 10, 2020
@khos2ow khos2ow deleted the header branch January 10, 2020 21:40
@git4raj
Copy link

git4raj commented Dec 2, 2020

Still happening in version v0.10.1. Comments in the main.tf is not coming in the output

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[v0.8.0-rc.1] Module comments from main.tf are no longer included in output
2 participants