Add script for checking titles
This commit is contained in:
+1
-1
@@ -14,4 +14,4 @@ install:
|
||||
script:
|
||||
- go test -v k8s.io/kubernetes.github.io/test
|
||||
- $GOPATH/bin/md-check --root-dir=$HOME/gopath/src/k8s.io/kubernetes.github.io
|
||||
- ./verify-entry-toc.sh
|
||||
- ./verify-docs-format.sh
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
# Put files you want to skip "titles:" check here:
|
||||
docs/sitemap.md
|
||||
Executable
+48
@@ -0,0 +1,48 @@
|
||||
#!/bin/bash
|
||||
|
||||
no_entry=false
|
||||
no_entry_counter=0
|
||||
no_title=false
|
||||
no_title_counter=0
|
||||
|
||||
# Verify all docs/.../*.md files
|
||||
for file in `find docs -name "*.md" -type f`; do
|
||||
# 1. TOC check:
|
||||
# Check they are referenced in at least one of _data/*.yml files.
|
||||
# Skip checking files in skip_toc_check.txt
|
||||
if ! grep -q "${file}" skip_toc_check.txt; then
|
||||
path=${file%.*}
|
||||
# abc/index.md should point to abc, not abc/index
|
||||
path=${path%%index}
|
||||
if ! grep -q "${path}" _data/*.yml; then
|
||||
echo "Error: ${file} doesn't have an entry in the table of contents under _data/*.yml"
|
||||
no_entry=true
|
||||
no_entry_counter=$[no_entry_counter+1]
|
||||
fi
|
||||
fi
|
||||
|
||||
# 2. Title check:
|
||||
# Check they have a proper title.
|
||||
# Skip checking files in skip_title_check.txt
|
||||
# Title should start with "title:" and can have several spaces/tabs between
|
||||
# non-space/tab content.
|
||||
# For example, "title:", " title: abc", and "title:" aren't valid,
|
||||
# but "title: abc", "title:def" and "title: def ghi" are both valid.
|
||||
if ! grep -q "${file}" skip_title_check.txt; then
|
||||
if ! grep -q "^title:\s*[^\s]" ${file}; then
|
||||
echo "Error: ${file} doesn't have a proper title defined!"
|
||||
no_title=true
|
||||
no_title_counter=$[no_title_counter+1]
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
if ${no_entry}; then
|
||||
echo "Found ${no_entry_counter} files without entries. For how to fix it, see http://kubernetes.io/docs/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ${no_title}; then
|
||||
echo "Found ${no_title_counter} files without titles."
|
||||
exit 1
|
||||
fi
|
||||
@@ -1,22 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
no_entry=false
|
||||
|
||||
# Verify all docs/.../*.md files are referenced in at least one of _data/*.yml
|
||||
# files. Skip checking files in skip_toc_check.txt
|
||||
for file in `find docs -name "*.md" -type f`; do
|
||||
if ! grep -q "${file}" skip_toc_check.txt; then
|
||||
path=${file%.*}
|
||||
# abc/index.md should point to abc, not abc/index
|
||||
path=${path%%index}
|
||||
if ! grep -q "${path}" _data/*.yml; then
|
||||
echo "Error: ${file} doesn't have an entry in the table of contents under _data/*.yml"
|
||||
no_entry=true
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
if ${no_entry}; then
|
||||
echo "Found files without entries. For how to fix it, see http://kubernetes.io/docs/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents"
|
||||
exit 1
|
||||
fi
|
||||
Reference in New Issue
Block a user