You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by sj...@apache.org on 2020/11/09 14:17:38 UTC
[flink-statefun] 01/01: [FLINK-20009][docs] Add documentation link
check to travis
This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 60ee9bf775185a9afa605bf963e224a82f4c8edd
Author: Seth Wiesman <sj...@gmail.com>
AuthorDate: Thu Nov 5 13:44:25 2020 -0600
[FLINK-20009][docs] Add documentation link check to travis
This closes #171
---
.travis.yml | 5 +++++
tools/ci/docs.sh | 45 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 50 insertions(+)
diff --git a/.travis.yml b/.travis.yml
index 04e58fd..44bfd3c 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -30,3 +30,8 @@ jobs:
jdk: "openjdk11"
script: mvn clean install -Prun-e2e-tests
name: build - jdk11
+ - if: type = (pull_request, push)
+ script: ./tools/ci/docs.sh
+ language: ruby
+ rvm: 2.4.0
+ name: Documentation links check
diff --git a/tools/ci/docs.sh b/tools/ci/docs.sh
new file mode 100755
index 0000000..76586ed
--- /dev/null
+++ b/tools/ci/docs.sh
@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+################################################################################
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+################################################################################
+
+# fail immediately
+set -o errexit
+set -o nounset
+
+BASE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+PROJECT_ROOT="${BASE_DIR}/../../"
+
+# Sanity check to ensure that resolved paths are valid
+if [ ! -f ${PROJECT_ROOT}/docs/build_docs.sh ]; then
+ echo "Project root path ${PROJECT_ROOT} is not valid; script may be in the wrong directory."
+ exit 1
+fi
+
+CACHE_DIR=$HOME/gem_cache ${PROJECT_ROOT}/docs/build_docs.sh -p &
+
+for i in `seq 1 30`;
+do
+ echo "Waiting for server..."
+ curl -Is http://localhost:4000 --fail
+ if [ $? -eq 0 ]; then
+ break
+ fi
+ sleep 10
+done
+
+${PROJECT_ROOT}/docs/check_links.sh