Skip to content

v0.18.0

Latest
Latest
Compare
Choose a tag to compare
@tf-docs-bot tf-docs-bot released this 30 May 23:16
· 7 commits to master since this release
v0.18.0
228c7a7

Notable Updates

The most notable changes in this release are:

  • Resources can get ignored using terraform-docs-ignore comment:

    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"
}

  • 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:

    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

Bug Fixes

  • 656f6a6 Fix output values with null
  • d5a55ae more fixes of binary name with missing s
  • 1b2dbab more fixes of binary name with missing s
  • 29e186a Fixed binary name in description output

Chores

  • 5e77bcc Bump actions/checkout from 3 to 4
  • 21313cf Bump actions/setup-go from 3 to 5
  • 89b52d5 Bump alpine from 3.18.5 to 3.19.0
  • 01435d7 Bump alpine from 3.19.0 to 3.19.1
  • b87d0e0 Bump alpine from 3.19.1 to 3.20.0 in /scripts/release
  • 50a8858 Bump codecov/codecov-action from 1 to 3
  • e729518 Bump codecov/codecov-action from 3 to 4
  • 70ed14e Bump dawidd6/action-homebrew-bump-formula from 3.10.1 to 3.11.0
  • 73ae81c Bump dawidd6/action-homebrew-bump-formula from 3.8.0 to 3.10.1
  • 127dba6 Bump docker/login-action from 1 to 3
  • 4dc7807 Bump github/codeql-action from 1 to 3
  • 7a00604 Bump golang from 1.21.5-alpine to 1.22.1-alpine
  • a321c28 Bump golang to 1.22.1
  • d6331c1 Bump golang.org/x/net from 0.19.0 to 0.23.0
  • 5a70c7a Bump google.golang.org/protobuf from 1.31.0 to 1.33.0
  • ff0ce44 Bump google.golang.org/protobuf from 1.31.0 to 1.33.0
  • ca3eea1 Bump goreleaser/goreleaser-action from 2 to 5
  • 38fc0e6 Bump softprops/action-gh-release from 1 to 2
  • f92cf6f Bump version to v0.18.0-alpha
  • 6041ae9 Change dependabot cadence to daily
  • 159bc83 Create dependabot file
  • e5a9ee0 --- 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 ...
  • 228c7a7 Release version v0.18.0
  • 656aa7c Update go crypto lib to v0.17.0
  • 2b71b4d chore: add release-cut workflow
  • d5e48a5 chore: add scripts/release/ folder to dependabot
  • fde40b1 chore: bump alpine to 3.20.0
  • b79a7c4 chore: bump golang to 1.22.3
  • 288faea chore: update dependencies
  • 740e0a8 go get -u github.com/hashicorp/hcl/v2, update to v0.20.1 to support provider functions

Docker images

  • docker pull quay.io/terraform-docs/terraform-docs:latest
  • docker pull quay.io/terraform-docs/terraform-docs:0.18.0

Contributors

Very special thanks to the contributors.

Contributors

EppO, khos2ow, and 8 other contributors
Assets 13