diff --git a/Makefile b/Makefile index d5d53f30e..74d82ea0f 100644 --- a/Makefile +++ b/Makefile @@ -79,6 +79,7 @@ test-unit: test-style: @scripts/validate-go.sh @scripts/validate-license.sh + @scripts/validate-generated-docs.sh .PHONY: protoc protoc: diff --git a/scripts/validate-generated-docs.sh b/scripts/validate-generated-docs.sh new file mode 100755 index 000000000..fe701a1d4 --- /dev/null +++ b/scripts/validate-generated-docs.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env bash + +# Copyright 2016 The Kubernetes Authors All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +set -euo pipefail + +echo "==> Running generated docs validations <==" + +make docs > /dev/null + +status="$(git status --porcelain -- ./docs)" +if [[ -n "${status}" ]]; then + echo + echo "Auto generated docs are outdated. Run `make docs`" + echo + exit 1 +fi