Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
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
force-pushed
the
ap/upgrade-terraform-docs
branch
from
November 18, 2026 21:08
a34657d to
d884d61
Compare
apeabody
marked this pull request as ready for review
November 18, 2026 21:17
- 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
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Releases
cft/developer-tools1.29.0, upgradingterraform-docsfrom0.16.0to0.25.1and wiring it into the automatedupdate-toolingworkflow while preserving full output compatibility with existing module READMEs.Changes
infra/build/Makefile:DOCKER_TAG_VERSION_DEVELOPER_TOOLSfrom1.28.1to1.29.0so the release does not overwrite:1.28.1in-place (and subsequentupdate-toolingruns bump to1.29.1).TERRAFORM_DOCS_VERSIONfrom0.16.0to0.25.1and add the# Updated by Update Tooling Workflowannotation..github/workflows/update-tooling.yml: AddTERRAFORM_DOCS_URLand include"TERRAFORM_DOCS"intools=(...)so futureterraform-docsreleases are picked up automatically.infra/build/developer-tools/build/install_terraform_docs.sh: Update release download URL from deprecatedsegmentio/terraform-docstoterraform-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 moduleREADME.mdfiles continue passingcheck_documentationwithout churn.Testing
bash -nandshellcheckon updated shell scripts.terraform_docs.shwithterraform-docsv0.25.1across 139 module and example directories (terraform-google-project-factory,terraform-google-network,terraform-google-kubernetes-engine, andcloud-foundation-toolkit) — confirmed0byte diffs across 139/139 directories.