github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-26 05:03:09 +00:00
Code Issues Projects Releases Wiki Activity

make mungedoc exit 1 if manual changes are needed and wire up erro message.

Browse Source
This commit is contained in:
Mike Danese 2015-07-15 09:49:21 -07:00
parent 8f3c3108b8
commit d4d99deb97
3 changed files with 17 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
cmd/mungedocs/mungedocs.go
View File

@ -187,7 +187,7 @@ func main() {
// - If verify is true: exit 0 if no changes needed, exit 1 if changes // - If verify is true: exit 0 if no changes needed, exit 1 if changes
// needed. // needed.
// - If verify is false: exit 0 if changes successfully made or no // - If verify is false: exit 0 if changes successfully made or no
// changes needed. // changes needed, exit 1 if manual changes are needed.
var changesNeeded bool var changesNeeded bool
err := filepath.Walk(leaf, newWalkFunc(&fp, &changesNeeded)) err := filepath.Walk(leaf, newWalkFunc(&fp, &changesNeeded))
@ -195,8 +195,12 @@ func main() {
fmt.Fprintf(os.Stderr, "ERROR: %v\n", err) fmt.Fprintf(os.Stderr, "ERROR: %v\n", err)
os.Exit(2) os.Exit(2)
} }
if changesNeeded && *verify { if changesNeeded {
fmt.Fprintf(os.Stderr, "FAIL: changes needed but not made due to --verify\n") if *verify {
fmt.Fprintf(os.Stderr, "FAIL: changes needed but not made due to --verify\n")
} else {
fmt.Fprintf(os.Stderr, "FAIL: some manual changes are still required.\n")
}
os.Exit(1) os.Exit(1)
} }
} }

10
hack/run-gendocs.sh
View File

@ -45,22 +45,20 @@ kube::util::gen-doc "${genman}" "${KUBE_ROOT}" "docs/man/man1"
kube::util::gen-doc "${genbashcomp}" "${KUBE_ROOT}" "contrib/completions/bash/" kube::util::gen-doc "${genbashcomp}" "${KUBE_ROOT}" "contrib/completions/bash/"
kube::util::gen-analytics "${KUBE_ROOT}" kube::util::gen-analytics "${KUBE_ROOT}"
"${mungedocs}" "--root-dir=${KUBE_ROOT}/docs/" "${mungedocs}" "--root-dir=${KUBE_ROOT}/docs/" && ret=0 || ret=$?
ret=$?
if [[ $ret -eq 1 ]]; then if [[ $ret -eq 1 ]]; then
echo "${KUBE_ROOT}/docs/ requires manual changes. See preceeding errors." echo "${KUBE_ROOT}/docs/ requires manual changes. See preceeding errors."
exit 1 exit 1
elif [[ $ret -eq 2 ]]; then elif [[ $ret -gt 1 ]]; then
echo "Error running mungedocs." echo "Error running mungedocs."
exit 1 exit 1
fi fi
"${mungedocs}" "--root-dir=${KUBE_ROOT}/examples/" "${mungedocs}" "--root-dir=${KUBE_ROOT}/examples/" && ret=0 || ret=$?
ret=$?
if [[ $ret -eq 1 ]]; then if [[ $ret -eq 1 ]]; then
echo "${KUBE_ROOT}/examples/ requires manual changes. See preceeding errors." echo "${KUBE_ROOT}/examples/ requires manual changes. See preceeding errors."
exit 1 exit 1
elif [[ $ret -eq 2 ]]; then elif [[ $ret -gt 1 ]]; then
echo "Error running mungedocs." echo "Error running mungedocs."
exit 1 exit 1
fi fi

16
hack/verify-gendocs.sh
View File

@ -49,24 +49,22 @@ cp -a "${DOCROOT}" "${TMP_DOCROOT}"
# mungedocs --verify can (and should) be run on the real docs, otherwise their # mungedocs --verify can (and should) be run on the real docs, otherwise their
# links will be distorted. --verify means that it will not make changes. # links will be distorted. --verify means that it will not make changes.
"${mungedocs}" "--verify=true" "--root-dir=${DOCROOT}" "${mungedocs}" "--verify=true" "--root-dir=${DOCROOT}" && ret=0 || ret=$?
ret=$?
if [[ $ret -eq 1 ]]; then if [[ $ret -eq 1 ]]; then
echo "${DOCROOT} is out of date. Please run hack/run-gendocs.sh" echo "${DOCROOT} is out of date. Please run hack/run-gendocs.sh"
exit 1 exit 1
fi fi
if [[ $ret -eq 2 ]]; then if [[ $ret -gt 1 ]]; then
echo "Error running mungedocs" echo "Error running mungedocs"
exit 1 exit 1
fi fi
"${mungedocs}" "--verify=true" "--root-dir=${EXAMPLEROOT}" "${mungedocs}" "--verify=true" "--root-dir=${EXAMPLEROOT}" && ret=0 || ret=$?
ret=$?
if [[ $ret -eq 1 ]]; then if [[ $ret -eq 1 ]]; then
echo "${EXAMPLEROOT} is out of date. Please run hack/run-gendocs.sh" echo "${EXAMPLEROOT} is out of date. Please run hack/run-gendocs.sh"
exit 1 exit 1
fi fi
if [[ $ret -eq 2 ]]; then if [[ $ret -gt 1 ]]; then
echo "Error running mungedocs" echo "Error running mungedocs"
exit 1 exit 1
fi fi
@ -75,8 +73,7 @@ kube::util::gen-doc "${genman}" "${_tmp}" "docs/man/man1/"
kube::util::gen-doc "${gendocs}" "${_tmp}" "docs/user-guide/kubectl/" '###### Auto generated by spf13/cobra' kube::util::gen-doc "${gendocs}" "${_tmp}" "docs/user-guide/kubectl/" '###### Auto generated by spf13/cobra'
echo "diffing ${DOCROOT} against freshly generated docs" echo "diffing ${DOCROOT} against freshly generated docs"
ret=0 diff -Naupr "${DOCROOT}" "${TMP_DOCROOT}" && ret=0 || ret=$?
diff -Naupr "${DOCROOT}" "${TMP_DOCROOT}" || ret=$?
rm -rf "${_tmp}" rm -rf "${_tmp}"
needsanalytics=($(kube::util::gen-analytics "${KUBE_ROOT}" 1)) needsanalytics=($(kube::util::gen-analytics "${KUBE_ROOT}" 1))
if [[ ${#needsanalytics[@]} -ne 0 ]]; then if [[ ${#needsanalytics[@]} -ne 0 ]]; then
@ -96,8 +93,7 @@ COMPROOT="${KUBE_ROOT}/contrib/completions"
TMP_COMPROOT="${KUBE_ROOT}/contrib/completions_tmp" TMP_COMPROOT="${KUBE_ROOT}/contrib/completions_tmp"
cp -a "${COMPROOT}" "${TMP_COMPROOT}" cp -a "${COMPROOT}" "${TMP_COMPROOT}"
kube::util::gen-doc "${genbashcomp}" "${TMP_COMPROOT}" "bash/" kube::util::gen-doc "${genbashcomp}" "${TMP_COMPROOT}" "bash/"
ret=0 diff -Naupr "${COMPROOT}" "${TMP_COMPROOT}" && ret=0 || ret=$?
diff -Naupr "${COMPROOT}" "${TMP_COMPROOT}" || ret=$?
rm -rf ${TMP_COMPROOT} rm -rf ${TMP_COMPROOT}
if [ $ret -eq 0 ] if [ $ret -eq 0 ]
then then