Awesome
tfdocs-format-template
tfdocs-format-template
is a minimal terraform-docs plugin that is built with
plugin SDK and is meant to be used as a template for implementing new plugin.
Most of the time you only need to modify and reorder the go template defined in
sections.tmpl
.
Requirements
- Go 1.16+
- terraform-docs v0.16+
Optionally for releasing:
Installation
In order to install a plugin the following steps are needed:
- download the plugin and place it in
~/.tfdocs.d/plugins
(or./.tfdocs.d/plugins
) - make sure the plugin file name is
tfdocs-format-<NAME>
(e.g<NAME>
should betemplate
) - modify
formatter
of.terraform-docs.yml
file to be<NAME>
Important notes:
- if the plugin file name is different than the example above,
terraform-docs
won't be able to to pick it up nor register it properly. - you can only use plugin thorough
.terraform-docs.yml
file and it cannot be used with CLI arguments
Building
Create a repository from this by clicking Use this template
and then clone the
newly created repository locally and run the following command:
make
You can then install the plugin to ~/.tfdocs.d/plugins
by running the following:
make install
Additionally you can override the destination of installation:
PLUGIN_FOLDER=/path/to/plugin/folder make install
Note that the plugin has to be built for target OS and archetecture (make build
and make install
do that,) but if you want to redistribute the plugin for other
people to use you have to cross-compile it (for example you can use gox.)