feat: adds terraform-docs as a linter 📄 #946
Open
Conversation
This file contains 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
⏱️ 27m total CI duration on this PR
|
Gowiem
commented
Dec 31, 2024
| output: rewrite | ||
| formatter: true | ||
| run_from: ${target_directory} | ||
| run: terraform-docs markdown --output-file=README.md . |
There was a problem hiding this comment.
One note here: This is my team and I's (and I would suspect many many others) most common usage when using terraform-docs with terraform child + root modules. However, the tool is fairly configurable and can be run in a lot of different ways. I didn't see an obvious example of how make these run commands configurable, so I figured I'd put up this lightly working version for review + ask for feedback from the trunk team.
Do ya'll have any other configurable plugins that I should check out for inspiration to make sure this doesn't need an immediate update from the 2nd person to use it?
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.
Info
terraform-docsas a linter plugin to support automatically generating + updating terraform module documentation for terraform projects.