Skip to content

chore(build): release dev-tools 1.29.0 with terraform-docs 0.25.1 - #3540

Open
apeabody wants to merge 4 commits into
mainfrom
ap/upgrade-terraform-docs
Open

apeabody wants to merge 4 commits into
mainfrom
ap/upgrade-terraform-docs

Conversation

@apeabody

@apeabody apeabody commented Nov 18, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Releases cft/developer-tools 1.29.0, upgrading terraform-docs from 0.16.0 to 0.25.1 and wiring it into the automated update-tooling workflow while preserving full output compatibility with existing module READMEs.

Changes

  • infra/build/Makefile:
    • Bump DOCKER_TAG_VERSION_DEVELOPER_TOOLS from 1.28.1 to 1.29.0 so the release does not overwrite :1.28.1 in-place (and subsequent update-tooling runs bump to 1.29.1).
    • Bump TERRAFORM_DOCS_VERSION from 0.16.0 to 0.25.1 and add the # Updated by Update Tooling Workflow annotation.
  • .github/workflows/update-tooling.yml: Add TERRAFORM_DOCS_URL and include "TERRAFORM_DOCS" in tools=(...) so future terraform-docs releases are picked up automatically.
  • infra/build/developer-tools/build/install_terraform_docs.sh: Update release download URL from deprecated segmentio/terraform-docs to terraform-docs/terraform-docs.
  • infra/build/developer-tools/build/scripts/task_wrapper_scripts/terraform_docs.sh: Normalize generated Markdown table separator spacing (| ---- | -> |------|) and line break tags (<br/> -> <br>) strictly within the <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> block so existing module README.md files continue passing check_documentation without churn.

Testing

  • Verified bash -n and shellcheck on updated shell scripts.
  • Empirically tested terraform_docs.sh with terraform-docs v0.25.1 across 139 module and example directories (terraform-google-project-factory, terraform-google-network, terraform-google-kubernetes-engine, and cloud-foundation-toolkit) — confirmed 0 byte diffs across 139/139 directories.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates terraform-docs from version 0.16.0 to 0.25.1, updating its download source URL and adding an awk post-processing step in the wrapper script to preserve legacy Markdown table formatting and HTML tags. The review feedback recommends improving the robustness of the awk script by handling CRLF line endings and trailing whitespaces, as well as ensuring the temporary file is cleaned up if the command fails.

@apeabody
apeabody force-pushed the ap/upgrade-terraform-docs branch from a34657d to d884d61 Compare November 18, 2026 21:08
@apeabody
apeabody marked this pull request as ready for review November 18, 2026 21:17
@apeabody apeabody changed the title fix(build): upgrade terraform-docs to 0.25.1 fix(build): upgrade terraform-docs to 0.25.1 and add to update-tooling Nov 18, 2026
@apeabody apeabody changed the title fix(build): upgrade terraform-docs to 0.25.1 and add to update-tooling chore(build): add terraform-docs to update-tooling workflow Nov 18, 2026
@apeabody apeabody changed the title chore(build): add terraform-docs to update-tooling workflow chore(build): release dev-tools 1.29.0 with terraform-docs 0.25.1 Nov 18, 2026
- TERRAFORM: 1.15.8 -> 1.17.2
- CLOUD_SDK: 577.0.0 -> 594.0.0
- TERRAGRUNT: 1.1.1 -> 1.2.2
- KUSTOMIZE: 5.8.1 -> 5.8.3
- KPT: 1.0.0-beta.67 -> 1.0.1 (latest stable GA; update install_kpt.sh to kptdev/kpt)
- TFLINT: 0.64.0 -> 0.66.0
- GOLANGCI: 2.12.2 -> 2.15.0
- GCRANE: 0.21.7 -> 0.22.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant