manage mdtoc version centrally with a tool module

Author: BenTheElder

hack/diff-toc-vs-template.sh

@@ -18,29 +18,11 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-# keep in sync with hack/verify-toc.sh
-# TODO: dedupe
-TOOL_VERSION=v1.1.0
-
 # cd to the root path
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
 cd "${ROOT}"
 
-# create a temporary directory
-TMP_DIR=$(mktemp -d)
-# cleanup
-exitHandler() (
-  echo "Cleaning up..."
-  rm -rf "${TMP_DIR}"
-)
-trap exitHandler EXIT
-# Perform go install in a temp dir as we are not tracking this version in a go
-# module.
-# If we do the go install in the repo, it will create/update go.mod and go.sum.
-cd "${TMP_DIR}"
-GO111MODULE=on GOBIN="${TMP_DIR}" go install "sigs.k8s.io/mdtoc@${TOOL_VERSION}"
-export PATH="${TMP_DIR}:${PATH}"
-cd "${ROOT}"
+MDTOC=(go tool -modfile="${ROOT}/hack/tools/mdtoc/go.mod" mdtoc)
 
 # Identify KEP files changed by the PR:
 # default from prow env if unset from args
@@ -89,7 +71,7 @@ readonly mdtoc_options=(
     # wouldn't surface them in the checked-in toc in update-toc.sh
     '--max-depth' '100'
 )
-template_toc=$(mdtoc "${mdtoc_options[@]}" "${template_readme}")
+template_toc=$("${MDTOC[@]}" "${mdtoc_options[@]}" "${template_readme}")
 
 result=0
 # get KEP README files changed in the diff
@@ -103,7 +85,7 @@ do
 done < <(git diff-tree --no-commit-id --name-only -r "${base}".."${target}")
 
 for kep_readme in "${kep_readmes[@]}"; do
-    kep_toc=$(mdtoc "${mdtoc_options[@]}" "${kep_readme}")
+    kep_toc=$("${MDTOC[@]}" "${mdtoc_options[@]}" "${kep_readme}")
     echo >&2 "Diffing table of contents for $kep_readme:"
     # diff only removals versus the template
     # we don't care about _additional_ headings in the KEP

hack/tools/mdtoc/go.mod

@@ -0,0 +1,17 @@
+module k8s.io/enhancements/hack/tools/mdtoc
+
+go 1.25
+
+tool sigs.k8s.io/mdtoc
+
+require (
+	github.com/BurntSushi/toml v0.3.1 // indirect
+	github.com/common-nighthawk/go-figure v0.0.0-20210622060536-734e95fb86be // indirect
+	github.com/gomarkdown/markdown v0.0.0-20240328165702-4d01890c35c0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/mmarkdown/mmark v2.0.40+incompatible // indirect
+	github.com/spf13/cobra v1.8.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	sigs.k8s.io/mdtoc v1.4.0 // indirect
+	sigs.k8s.io/release-utils v0.8.3 // indirect
+)

hack/tools/mdtoc/go.sum

@@ -0,0 +1,29 @@
+github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/common-nighthawk/go-figure v0.0.0-20210622060536-734e95fb86be h1:J5BL2kskAlV9ckgEsNQXscjIaLiOYiZ75d4e94E6dcQ=
+github.com/common-nighthawk/go-figure v0.0.0-20210622060536-734e95fb86be/go.mod h1:mk5IQ+Y0ZeO87b858TlA645sVcEcbiX6YqP98kt+7+w=
+github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gomarkdown/markdown v0.0.0-20240328165702-4d01890c35c0 h1:4gjrh/PN2MuWCCElk8/I4OCKRKWCCo2zEct3VKCbibU=
+github.com/gomarkdown/markdown v0.0.0-20240328165702-4d01890c35c0/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/mmarkdown/mmark v2.0.40+incompatible h1:vMeUeDzBK3H+/mU0oMVfMuhSXJlIA+DE/DMPQNAj5C4=
+github.com/mmarkdown/mmark v2.0.40+incompatible/go.mod h1:Uvmoz7tvsWpr7bMVxIpqZPyN3FbOtzDmnsJDFp7ltJs=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
+github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+sigs.k8s.io/mdtoc v1.4.0 h1:2pDEwJSjoVrGr5BPkG+LoLkYLKvgtGYurrBY8ul3SxQ=
+sigs.k8s.io/mdtoc v1.4.0/go.mod h1:KVnRRtK1rX9aQ95qF0rt3x2ytTxf3r7W7N41H+0KF0k=
+sigs.k8s.io/release-utils v0.8.3 h1:KtOtA4qDmzJyeQ2zkDsFVI25+NViwms/o5eL2NftFdA=
+sigs.k8s.io/release-utils v0.8.3/go.mod h1:fp82Fma06OXBhEJ+GUJKqvcplDBomruK1R/1fWJnsrQ=

hack/update-toc.sh

@@ -18,35 +18,16 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-# keep in sync with hack/verify-toc.sh
-TOOL_VERSION=v1.1.0
-
 # cd to the root path
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
 cd "${ROOT}"
 
-# create a temporary directory
-TMP_DIR=$(mktemp -d)
-
-# cleanup
-exitHandler() (
-  echo "Cleaning up..."
-  rm -rf "${TMP_DIR}"
-)
-trap exitHandler EXIT
-
-# Perform go install in a temp dir as we are not tracking this version in a go
-# module.
-# If we do the go install in the repo, it will create/update go.mod and go.sum.
-cd "${TMP_DIR}"
-GO111MODULE=on GOBIN="${TMP_DIR}" go install "sigs.k8s.io/mdtoc@${TOOL_VERSION}"
-export PATH="${TMP_DIR}:${PATH}"
-cd "${ROOT}"
+MDTOC=(go tool -modfile="${ROOT}/hack/tools/mdtoc/go.mod" mdtoc)
 
 # Update tables of contents if necessary.
 find keps -name '*.md' \
     | grep -Fxvf hack/.notableofcontents \
-    | xargs mdtoc --inplace --max-depth=5  || (
+    | xargs "${MDTOC[@]}" --inplace --max-depth=5  || (
       echo "Failed generating TOC. If this failed silently and you are on mac, try 'brew install grep'"
       exit 1
     )

hack/verify-toc.sh

@@ -18,35 +18,17 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-# keep in sync with hack/update-toc.sh
-TOOL_VERSION=v1.1.0
-
 # cd to the root path
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
 cd "${ROOT}"
 
-# create a temporary directory
-TMP_DIR=$(mktemp -d)
-
-# cleanup
-exitHandler() (
-  echo "Cleaning up..."
-  rm -rf "${TMP_DIR}"
-)
-trap exitHandler EXIT
-
-# perform go install in a temp dir as we are not tracking this version in a go module
-# if we do the go install in the repo, it will create / update a go.mod and go.sum
-cd "${TMP_DIR}"
-GO111MODULE=on GOBIN="${TMP_DIR}" go install "sigs.k8s.io/mdtoc@${TOOL_VERSION}"
-export PATH="${TMP_DIR}:${PATH}"
-cd "${ROOT}"
+MDTOC=(go tool -modfile="${ROOT}/hack/tools/mdtoc/go.mod" mdtoc)
 
 echo "Checking table of contents are up to date..."
 # Verify tables of contents are up-to-date
 find keps -name '*.md' \
     | grep -Fxvf hack/.notableofcontents \
-    | xargs mdtoc --inplace --max-depth=5 --dryrun || (
+    | xargs "${MDTOC[@]}" --inplace --max-depth=5 --dryrun || (
       echo "Table of content not up to date. Did you run 'make update-toc' ?"
       echo "If this failed silently and you are on mac, try 'brew install grep'"
       exit 1