terraform-docs-recursive

Recursively generate terraform documentation for all modules in a directory.

This project is a wrapper around terraform-docs with logic to recursively find and generate documentation for all modules in a directory. In order for a module to be considered for documentation, its directory (or any of its parent directories) must contain a terraform-docs configuration file. terraform-docs-recursive will use whichever configuration file is found first in the directory tree.

Usage

Run as a CLI

terraform-docs-recursive docs .

Install with homebrew

brew tap juftin/terraform-docs-recursive https://github.com/juftin/terraform-docs-recursive
brew install terraform-docs-recursive

Install with Go

go install github.com/juftin/terraform-docs-recursive@v1.6.0

Pre-Commit Hook

To use this project as a pre-commit hook you can add the following to your .pre-commit-config.yaml:

repos:
    - repo: https://github.com/juftin/terraform-docs-recursive
      rev: v1.6.0
      hooks:
          - id: terraform-docs-recursive

GitHub Actions

name: Generate Terraform Docs
on:
    push:
runs-on: ubuntu-latest
steps:
    - name: Checkout Repository
      uses: actions/checkout@v4
    - name: Generate Terraform Docs
      uses: juftin/terraform-docs-recursive@v1
    - name: Commit Changes
      uses: EndBug/add-and-commit@v9
      with:
          message: 📝 update terraform documentation
          default_author: github_actions