Sign inSign up

tmknom/terraform-docs

By tmknom

•Updated over 6 years ago

Generate docs from terraform modules.

Image
0

3.8K

tmknom/terraform-docs repository overview

⁠terraform-docs

Dockerfile Actions Status Shell Script Actions Status Markdown Actions Status YAML Actions Status JSON Actions Status

Docker Build Status Docker Automated build MicroBadger Size MicroBadger Layers License

Generate docs from terraform modules based on Docker.

This is terraform-docs⁠ wrapper.

⁠Requirements

⁠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 [email protected]: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
  2. GitHub Actions - Continuous Integration
  3. Docker Hub - Docker Registry
  4. MicroBadger - Docker Inspection

⁠License

Apache 2 Licensed. See LICENSE for full details.

Tag summary

Content type

Image

Digest

Size

3 MB

Last updated

over 6 years ago

docker pull tmknom/terraform-docs