diff --git a/.travis.yml b/.travis.yml index 9d7572f9168..770f7f33325 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,6 +19,7 @@ script: - PATH=$GOPATH/bin:$PATH ./hack/verify-generated-deep-copies.sh - PATH=$GOPATH/bin:./third_party/etcd:$PATH ./hack/verify-gendocs.sh - PATH=$GOPATH/bin:./third_party/etcd:$PATH ./hack/verify-swagger-spec.sh + - PATH=$GOPATH/bin:./third_party/etcd:$PATH ./hack/verify-linkcheck.sh - godep go test ./cmd/mungedocs notifications: diff --git a/cmd/linkcheck/links.go b/cmd/linkcheck/links.go index 7de7b9a4586..f3e49c3237d 100644 --- a/cmd/linkcheck/links.go +++ b/cmd/linkcheck/links.go @@ -14,6 +14,13 @@ See the License for the specific language governing permissions and limitations under the License. */ +//This command checks if the hyperlinks in files are valid. It checks the files +//with 'fileSuffix' in 'rootDir' for URLs that match 'prefix'. It trims the +//'prefix' from the URL, uses what's left as the relative path to repoRoot to +//verify if the link is valid. For example: +//$ linkcheck --root-dir=${TYPEROOT} --repo-root=${KUBE_ROOT} \ +// --file-suffix=types.go --prefix=http://releases.k8s.io/HEAD + package main import ( diff --git a/hooks/pre-commit b/hooks/pre-commit index c1ae5ee9d99..596cf73ed1f 100755 --- a/hooks/pre-commit +++ b/hooks/pre-commit @@ -100,7 +100,7 @@ echo "${reset}" echo -ne "Checking for links in API descriptions... " if ! hack/verify-linkcheck.sh > /dev/null; then echo "${red}ERROR!" - echo "Some links in pkg/api/.*types.go is outdated. They require manual fix." + echo "Some links in pkg/api/.*types.go are outdated. They require a manual fix." exit_code=1 else echo "${green}OK"