feat: adds terraform-docs as a linter 📄 #946
Conversation
⏱️ 27m total CI duration on this PR
|
| 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?
There was a problem hiding this comment.
@EliSchleifer any thoughts here or ship it and we can deal with any requests for configurability in the future?
linters/terraform-docs/plugin.yaml
Outdated
| main_tool: terraform-docs | ||
| description: Generate terraform + tofu module documentation | ||
| commands: | ||
| - name: terraform-docs |
There was a problem hiding this comment.
The command name should more map what the command does than the name of the tool. So in this case given the formatter nature I would set name to "format"
Info
terraform-docsas a linter plugin to support automatically generating + updating terraform module documentation for terraform projects.