You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 2, 2026. It is now read-only.
Add preliminary support OpenTofu, thanks to @jamesgeddes! We are now able to extract header and footer from .tofu files and generally make .tofu file a known filetype to terraform-docs.
[!NOTE]
With this release, we are still not able to read and parse all the .tofu files to extract all the other information, such as inputs, outputs, providers, etc.
// terraform-docs-ignore
output "foo" {
value = "foo"
}
- Skip root module documentation while executing recursively:
The main module document is generated by default, but should the main module document be
excluded from document generation, `--recursive-include-main=false` can be used or alternatively
in the `.terraform-docs.yml`:
```yml
recursive:
enabled: true
path: modules
include-main: false
Changelog
Features
943489c Ignore inputs with terraform-docs-ignore comment
8f74fd4 feat: ignore outputs, providers, resources with comments
d0862bd Update Dockerfile FROM command to use non-ambiguous container sources
59eb90f Make main module doc optional when in recursive generation
renovateBot
changed the title
Update dependency terraform-docs/terraform-docs to v0.17.0
Update dependency terraform-docs/terraform-docs to v0.18.0
May 31, 2024
renovateBot
changed the title
Update dependency terraform-docs/terraform-docs to v0.18.0
Update dependency terraform-docs/terraform-docs to v0.19.0
Sep 19, 2024
renovateBot
changed the title
Update dependency terraform-docs/terraform-docs to v0.19.0
Update dependency terraform-docs/terraform-docs to v0.20.0
Apr 5, 2025
renovateBot
changed the title
Update dependency terraform-docs/terraform-docs to v0.20.0
Update dependency terraform-docs/terraform-docs to v0.21.0
Dec 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
v0.16.0→v0.21.0Release Notes
terraform-docs/terraform-docs (terraform-docs/terraform-docs)
v0.21.0Compare Source
Notable Updates
Changelog
Dependency updates
929b3e0chore(deps): bump dependencies, golang version and base containers553f6adchore(deps): bump golang.org/x/net from 0.36.0 to 0.38.0Chores
0643382Release version v0.21.04ac0a6achore(linting): update to golangci-lint 2.7.2dd450a5chore: fix golangci-lint issuesDocker images
docker pull quay.io/terraform-docs/terraform-docs:latestdocker pull quay.io/terraform-docs/terraform-docs:0.21.0Contributors
Very special thanks to the contributors.
v0.20.0Compare Source
Notable Updates
Add preliminary support OpenTofu, thanks to @jamesgeddes! We are now able to extract header and footer from
.tofufiles and generally make.tofufile a known filetype to terraform-docs.Changelog
Features
bb09818add support for .tofu filesDependency updates
006ff31chore(deps): bump golang.org/x/crypto from 0.27.0 to 0.31.0e470746chore(deps): bump golang.org/x/net from 0.29.0 to 0.33.0adb8099chore(deps): bump golang.org/x/net from 0.33.0 to 0.36.073ee296chore(deps): bump library/alpine from 3.20.3 to 3.21.306ca95cchore(deps): bump library/alpine in /scripts/release616bff0chore(deps): bump library/golang from 1.23.1-alpine to 1.23.4-alpineChores
a22bdbeFix typo in insert-output-to-file.mdcf462c5Release version v0.20.08c170f2Update typo in pre-commit-hooks.md983e98achore: bump golang to 1.24.255d8916chore: bump version to v0.20.0-alpha93c1839chore: update staticcheck to 2025.1.1Docker images
docker pull quay.io/terraform-docs/terraform-docs:latestdocker pull quay.io/terraform-docs/terraform-docs:0.20.0Contributors
Very special thanks to the contributors.
v0.19.0Compare Source
Notable Updates
Changelog
Features
5a2f6ffadd docker multiarch buildBug Fixes
78e94dafix: Replace<br>with<br />for markdown syntaxaf31cc6fix: release scripts3c44c58Fix: Let Docker image be built correctly for non-amd64 platformsDependency updates
7da557achore(deps): bump docker/build-push-action from 5 to 6c825b41chore(deps): bump library/alpine from 3.20.0 to 3.20.25441df2chore(deps): bump library/alpine from 3.20.2 to 3.20.3a639fbdchore(deps): bump library/alpine in /scripts/releasea2f4573chore(deps): bump library/golang from 1.23.0-alpine to 1.23.1-alpineChores
045e5e6Bump google.golang.org/grpc from 1.64.0 to 1.64.1db5e64cBump goreleaser/goreleaser-action from 5 to 60562dbdBump library/alpine from 3.20.0 to 3.20.2 in /scripts/release7de82c8Bump library/golang from 1.22.3-alpine to 1.23.0-alpined64cd3bRelease version v0.19.08ae3344chore: bump version to v0.19.0-alphac2e8d0achore: fix linter issues3355644chore: update go dependencies0db6eefchore: update go to 1.23.111270e3chore: update staticcheck to 2024.1.1186bd7echore: update teaser image4c94478ci: Use correct env var for repo owner62756caci: Use correct var for repo owner (second try)1919452ci: enhance release workflows49fde02ci: fix release scriptsa97e171ci: kickoff actions runDocker images
docker pull quay.io/terraform-docs/terraform-docs:latestdocker pull quay.io/terraform-docs/terraform-docs:0.19.0Contributors
Very special thanks to the contributors.
v0.18.0Compare Source
Notable Updates
The most notable changes in this release are:
Resources can get ignored using
terraform-docs-ignorecomment:All types of resources can be ignored from the generated output by prepending them
with a comment
terraform-docs-ignore.##################################################################All of the following will be ignored from the generated output
##################################################################
terraform-docs-ignore
resource "foo_resource" "foo" {}
This resource is going to get ignored from generated
output by using the following known comment.
terraform-docs-ignore
The ignore keyword also doesn't have to be the first,
last, or the only thing in a leading comment
resource "bar_resource" "bar" {}
terraform-docs-ignore
data "foo_data_resource" "foo" {}
terraform-docs-ignore
data "bar_data_resource" "bar" {}
// terraform-docs-ignore
module "foo" {
source = "foo"
version = "x.x.x"
}
terraform-docs-ignore
variable "foo" {
default = "foo"
}
// terraform-docs-ignore
output "foo" {
value = "foo"
}
Changelog
Features
943489cIgnore inputs with terraform-docs-ignore comment8f74fd4feat: ignore outputs, providers, resources with commentsd0862bdUpdate Dockerfile FROM command to use non-ambiguous container sources59eb90fMake main module doc optional when in recursive generationBug Fixes
656f6a6Fix output values with nulld5a55aemore fixes of binary name with missing s1b2dbabmore fixes of binary name with missing s29e186aFixed binary name in description outputChores
5e77bccBump actions/checkout from 3 to 421313cfBump actions/setup-go from 3 to 589b52d5Bump alpine from 3.18.5 to 3.19.001435d7Bump alpine from 3.19.0 to 3.19.1b87d0e0Bump alpine from 3.19.1 to 3.20.0 in /scripts/release50a8858Bump codecov/codecov-action from 1 to 3e729518Bump codecov/codecov-action from 3 to 470ed14eBump dawidd6/action-homebrew-bump-formula from 3.10.1 to 3.11.073ae81cBump dawidd6/action-homebrew-bump-formula from 3.8.0 to 3.10.1127dba6Bump docker/login-action from 1 to 34dc7807Bump github/codeql-action from 1 to 37a00604Bump golang from 1.21.5-alpine to 1.22.1-alpinea321c28Bump golang to 1.22.1d6331c1Bump golang.org/x/net from 0.19.0 to 0.23.05a70c7aBump google.golang.org/protobuf from 1.31.0 to 1.33.0ff0ce44Bump google.golang.org/protobuf from 1.31.0 to 1.33.0ca3eea1Bump goreleaser/goreleaser-action from 2 to 538fc0e6Bump softprops/action-gh-release from 1 to 2f92cf6fBump version to v0.18.0-alpha6041ae9Change dependabot cadence to daily159bc83Create dependabot filee5a9ee0--- updated-dependencies: - dependency-name: alpine dependency-type: direct:production update-type: version-update:semver-patch ...75e05c0--- updated-dependencies: - dependency-name: golang dependency-type: direct:production update-type: version-update:semver-patch ...228c7a7Release version v0.18.0656aa7cUpdate go crypto lib to v0.17.02b71b4dchore: add release-cut workflowd5e48a5chore: add scripts/release/ folder to dependabotfde40b1chore: bump alpine to 3.20.0b79a7c4chore: bump golang to 1.22.3288faeachore: update dependencies740e0a8go get -u github.com/hashicorp/hcl/v2, update to v0.20.1 to support provider functionsDocker images
docker pull quay.io/terraform-docs/terraform-docs:latestdocker pull quay.io/terraform-docs/terraform-docs:0.18.0Contributors
Very special thanks to the contributors.
v0.17.0Compare Source
Changelog
Features
38a327aAdd fish shell completione72f215Always convert CRLF to LF for output descriptioneb2e3b7fix completion installing command230113fMove terraform-docs bin in a folder already in the Linux PATH5727f8bPreserve whitespaces of provided content and template65b37fbUpdate OpenSSL package to mitigate CVE-2023-5363Bug Fixes
4132916Fix CI linting3467aa9Fix faulty license headersb4d62c8Fix spellinga375aa7fix spaces9449cf8fix typoChores
4eb50aeBump alpine to 3.14.2c51e1acBump alpine to 3.16.0e5abff0Bump alpine to 3.18.56f4b4d8Bump golang to 1.17.68423fc0Bump golang to 1.18.1061f0423Bump golang to 1.18.347bb0d2Bump golang to 1.21.5f093753Bump golangci-lint to 1.47.2 and fix issues5cfb2f2Bump golangci-lint to 1.55.2 and fix issues9fa02e7Bump staticcheck to 2023.1.6b37d2dcBump version to v0.17.0-alphaa74d0f4Bump version to v1.0.0-alphaa89c52eEnhance release scriptac2f987Update actions/checkout to v3040b27bUpdate actions/setup-go to v35fad7abUpdate go dependencies649f1c4Update go module dependencies4552242Update go module dependencies82eaf8bUpdate goreleaser/goreleaser-actiona to v389666c0Update container to Alpine 3.18.2 and Go 1.18.105638b29Update Alpine base image to 3.16.121a9745Upgrade Google Cloud Go packages in go.sumbb12a12Remove Scalr sponsorship090efceRun make fmtDocker images
docker pull quay.io/terraform-docs/terraform-docs:latestdocker pull quay.io/terraform-docs/terraform-docs:0.17.0Contributors
Very special thanks to the contributors.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR was generated by Mend Renovate. View the repository job log.