Notable Updates
The most notable changes in this release are:
-
Add support for footer (thanks to @simonc-613)
-
Add anchors for markdown, asciidocs items (thanks to @nitrocode)
-
Save generated content directly into a file (mode
inject
andreplace
)-
inject: partially replace the target file with generated output
-
replace: completely replace the target file with generated output
The output generated by formatters (
markdown
,asciidoc
, etc) will be inserted into a template before getting saved into the file. This template can be customized with--output-template
CLI flag or corresponding item in.terraform-docs.yml
config file. Its default value is:<!-- BEGIN_TF_DOCS --> {{ .Content }} <!-- END_TF_DOCS -->
-
-
Remove
--no-XXX
flags. (in v0.10.0--no-XXX
have been deprecated in favor of their counterparts in the format of--XXX=false
)
Changelog
Features
aa1e6bb Add support for footer docs
1168e12 Add support for pre-commit hooks
ac5a29c Implement module sort by position (no sort)
243fb27 add mode resource or data source to generated docs
a3bafd6 Save generated content directly into a file
8c05cb9 Add resource 'Name' to generated docs
3d39a94 Add option to hide Type and Default columns
02f490d --anchor to add anchors for markdown, asciidocs
25d2ff4 Completely remove deprecated '--no-XXX' flags
Bug Fixes
7e489d2 Do not modify header lines and trailing whitespaces
c94b43a Template should be optional for output-mode 'replace'
Refactoring
10cd6de Add DCO file
5b57ea4 Disable codecov patch status
3cc4f44 Fix issues reported by golangci-lint
8faaf9f Remove authors file and corresponding scripts
c246442 Remove changelog and corresponding scripts
0c25f7b Update golangci-lint configuration
Docker images
docker pull quay.io/terraform-docs/terraform-docs:latest
docker pull quay.io/terraform-docs/terraform-docs:0.12.0
Contributors
Very special thanks to the contributors.