Skip to content

Commit 7e69f3b

Browse files
authored
Merge pull request kubernetes#2407 from thockin/clean-up-prr-template-markdown
Make the KEP PRR template more structured markdown
2 parents 47ff509 + cccc6fa commit 7e69f3b

File tree

7 files changed

+198
-124
lines changed

7 files changed

+198
-124
lines changed

hack/update-toc.sh

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ set -o nounset
1919
set -o pipefail
2020

2121
# keep in sync with hack/verify-toc.sh
22-
TOOL_VERSION=ee652eb78c047a7b6c7417d9324a97bb05689563
22+
TOOL_VERSION=b8c54a57d69f29386d055584e595f38d65ce2a1f
2323

2424
# cd to the root path
2525
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
@@ -38,9 +38,11 @@ trap exitHandler EXIT
3838
# perform go get in a temp dir as we are not tracking this version in a go module
3939
# if we do the go get in the repo, it will create / update a go.mod and go.sum
4040
cd "${TMP_DIR}"
41-
GO111MODULE=on GOBIN="${TMP_DIR}" go get "github.com/tallclair/mdtoc@${TOOL_VERSION}"
41+
GO111MODULE=on GOBIN="${TMP_DIR}" go get "sigs.k8s.io/mdtoc@${TOOL_VERSION}"
4242
export PATH="${TMP_DIR}:${PATH}"
4343
cd "${ROOT}"
4444

4545
# Update tables of contents if necessary.
46-
find keps -name '*.md' | grep -Fxvf hack/.notableofcontents | xargs mdtoc --inplace
46+
find keps -name '*.md' \
47+
| grep -Fxvf hack/.notableofcontents \
48+
| xargs mdtoc --inplace --max-depth=5

hack/verify-toc.sh

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ set -o nounset
1919
set -o pipefail
2020

2121
# keep in sync with hack/update-toc.sh
22-
TOOL_VERSION=ee652eb78c047a7b6c7417d9324a97bb05689563
22+
TOOL_VERSION=b8c54a57d69f29386d055584e595f38d65ce2a1f
2323

2424
# cd to the root path
2525
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
@@ -38,10 +38,12 @@ trap exitHandler EXIT
3838
# perform go get in a temp dir as we are not tracking this version in a go module
3939
# if we do the go get in the repo, it will create / update a go.mod and go.sum
4040
cd "${TMP_DIR}"
41-
GO111MODULE=on GOBIN="${TMP_DIR}" go get "github.com/tallclair/mdtoc@${TOOL_VERSION}"
41+
GO111MODULE=on GOBIN="${TMP_DIR}" go get "sigs.k8s.io/mdtoc@${TOOL_VERSION}"
4242
export PATH="${TMP_DIR}:${PATH}"
4343
cd "${ROOT}"
4444

4545
echo "Checking table of contents are up to date..."
4646
# Verify tables of contents are up-to-date
47-
find keps -name '*.md' | grep -Fxvf hack/.notableofcontents | xargs mdtoc --inplace --dryrun
47+
find keps -name '*.md' \
48+
| grep -Fxvf hack/.notableofcontents \
49+
| xargs mdtoc --inplace --max-depth=5 --dryrun

0 commit comments

Comments
 (0)