terraform-docs

Generate docs from terraform modules based on Docker.

This is terraform-docs wrapper.

Requirements

• Docker

Usage

Basic

docker run --rm -v "$PWD:/work" tmknom/terraform-docs

Specific directory

docker run --rm -v "$PWD:/work" tmknom/terraform-docs markdown /path/to/dir

Help

For details, refer to segmentio/terraform-docs.

docker run --rm tmknom/terraform-docs --help

Makefile targets

build                          Build docker image
format                         Format code
help                           Show help
install                        Install requirements
lint                           Lint code
release                        Release

Development

Installation

git clone git@github.com:tmknom/terraform-docs.git
cd terraform-docs
make install

Deployment

1. Bump VERSION file.
2. Run make release.
3. Automatically deployed by "Docker Hub Automated Build".

Deployment Pipeline

1. GitHub - Version Control System
   • https://github.com/tmknom/terraform-docs
2. GitHub Actions - Continuous Integration
   • https://github.com/tmknom/terraform-docs/actions
3. Docker Hub - Docker Registry
   • https://hub.docker.com/r/tmknom/terraform-docs
4. MicroBadger - Docker Inspection
   • https://microbadger.com/images/tmknom/terraform-docs

License

Apache 2 Licensed. See LICENSE for full details.