You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ma...@apache.org on 2026/02/19 13:27:39 UTC
(flink) 01/02: [hotfix][docs] Add docs.sh for legacy CI pipeline
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.8
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 2dfa179fa760df08f80fe0248f050cfcb1119baf
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:35:54 2026 +0100
[hotfix][docs] Add docs.sh for legacy CI pipeline
Adds GitHub Actions docs.sh script to enable building documentation via the docs-legacy workflow.
---
.github/workflows/docs.sh | 69 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
new file mode 100755
index 00000000000..bbad00fdccd
--- /dev/null
+++ b/.github/workflows/docs.sh
@@ -0,0 +1,69 @@
+#!/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.
+################################################################################
+set -e
+
+# override env to use Java 8 to for build
+# path to JDK is taken from https://github.com/apache/flink-connector-shared-utils/blob/ci_utils/docker/base/Dockerfile#L37-L40
+export JAVA_HOME=$JAVA_HOME_8_X64
+export PATH=$JAVA_HOME_8_X64/bin:$PATH
+
+mvn --version
+java -version
+javadoc -J-version
+
+# workaround for a git security patch
+git config --global --add safe.directory /root/flink
+
+# Disable Maven's default HTTP blocking for legacy repos
+mkdir -p ~/.m2
+cat > ~/.m2/settings.xml << 'EOF'
+<settings>
+ <mirrors>
+ <mirror>
+ <id>maven-default-http-blocker</id>
+ <mirrorOf>!*</mirrorOf>
+ <url>http://0.0.0.0/</url>
+ </mirror>
+ </mirrors>
+</settings>
+EOF
+
+# Jekyll docs are built in a separate step using docs/docker image
+# Move pre-built docs to target/ for consistency with other branches
+mv docs/content docs/target
+
+# build Flink; required for Javadoc step
+# Skip npm (node permission issues in Docker container)
+mvn clean install -B -DskipTests -Dfast -Dskip.npm
+
+# build java/scala docs
+mkdir -p docs/target/api
+mvn javadoc:aggregate -B \
+ -Paggregate-scaladoc \
+ -DadditionalJOption="-Xdoclint:none --allow-script-in-comments" \
+ -Dmaven.javadoc.failOnError=false \
+ -Dcheckstyle.skip=true \
+ -Dspotless.check.skip=true \
+ -Denforcer.skip=true \
+ -Dheader="<a href=\"http://flink.apache.org/\" target=\"_top\"><h1>Back to Flink Website</h1></a> <script>var _paq=window._paq=window._paq||[];_paq.push([\"disableCookies\"]),_paq.push([\"setDomains\",[\"*.flink.apache.org\",\"*.nightlies.apache.org/flink\"]]),_paq.push([\"trackPageView\"]),_paq.push([\"enableLinkTracking\"]),function(){var u=\"//analytics.apache.org/\";_paq.push([\"setTrackerUrl\",u+\"matomo.php\"]),_paq.push([\"setSiteId\",\"1\"]);var d=document, g=d.createElement( [...]
+mv target/site/apidocs docs/target/api/java
+pushd flink-scala
+mvn scala:doc -B
+mv target/site/scaladocs ../docs/target/api/scala
+popd