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 16:12:12 UTC
(flink) branch release-1.2 updated (328115d5a14 -> 104f23c398a)
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a change to branch release-1.2
in repository https://gitbox.apache.org/repos/asf/flink.git
from 328115d5a14 [FLINK-25880][docs] Add Matomo tracking code to base layout
new 1c23f821c7a [hotfix][docs] Add docs.sh for legacy CI pipeline
new 0fe224c2d92 [FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
new 1c1466cdb47 [FLINK-38925][docs] Update Matomo URL to the right domain
new 104f23c398a [hotfix] Use Ruby 2.3 Docker image to match Gemfile.lock
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.github/workflows/docs.sh | 87 +++++++++++++++++++++++++++++++++++++++++++++++
docs/_layouts/base.html | 2 +-
docs/build_docs.sh | 2 ++
docs/docker/Dockerfile | 13 +++++--
4 files changed, 100 insertions(+), 4 deletions(-)
create mode 100755 .github/workflows/docs.sh
(flink) 02/04: [FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.2
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 0fe224c2d92ec9ccb5f8141ff7f78b85af97d51e
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Wed Jan 21 15:42:51 2026 +0100
[FLINK-38955][docs] Add canonical tag to generated Javadoc and Scaladoc
(cherry picked from commit 8226f3b8b0f2da1fd5ed9d12ca1036551d6e4229)
---
.github/workflows/docs.sh | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
index bbad00fdccd..23947a9fd24 100755
--- a/.github/workflows/docs.sh
+++ b/.github/workflows/docs.sh
@@ -62,8 +62,26 @@ mvn javadoc:aggregate -B \
-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( [...]
+
+# Inject canonical tags into Javadoc HTML files to point to stable docs version
+CANONICAL_BASE="https://nightlies.apache.org/flink/flink-docs-stable/api/java"
+find target/site/apidocs -name "*.html" -type f | while read -r file; do
+ REL_PATH="${file#target/site/apidocs/}"
+ CANONICAL_URL="${CANONICAL_BASE}/${REL_PATH}"
+ sed -i "s|<head>|<head>\n<link rel=\"canonical\" href=\"${CANONICAL_URL}\">|" "$file"
+done
+
mv target/site/apidocs docs/target/api/java
pushd flink-scala
mvn scala:doc -B
+
+# Inject canonical tags into Scaladoc HTML files to point to stable docs version
+CANONICAL_BASE="https://nightlies.apache.org/flink/flink-docs-stable/api/scala"
+find target/site/scaladocs -name "*.html" -type f | while read -r file; do
+ REL_PATH="${file#target/site/scaladocs/}"
+ CANONICAL_URL="${CANONICAL_BASE}/${REL_PATH}"
+ sed -i "s|<head>|<head>\n<link rel=\"canonical\" href=\"${CANONICAL_URL}\">|" "$file"
+done
+
mv target/site/scaladocs ../docs/target/api/scala
popd
(flink) 04/04: [hotfix] Use Ruby 2.3 Docker image to match Gemfile.lock
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.2
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 104f23c398a02d93df37331bac2d14a7b989aa7b
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 11:17:03 2026 +0100
[hotfix] Use Ruby 2.3 Docker image to match Gemfile.lock
---
docs/build_docs.sh | 2 ++
docs/docker/Dockerfile | 13 ++++++++++---
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/docs/build_docs.sh b/docs/build_docs.sh
index cbdd1d42cd5..15c714d12a8 100755
--- a/docs/build_docs.sh
+++ b/docs/build_docs.sh
@@ -37,6 +37,8 @@ if [ "`command -v bundle`" == "" ]; then
fi
# Install Ruby dependencies locally
+# Fix jekyll-gist dependency metadata issue
+bundle update jekyll-gist
bundle install --path .rubydeps
DOCS_SRC=${DIR}
diff --git a/docs/docker/Dockerfile b/docs/docker/Dockerfile
index ad4bb307f7c..f215595b9d3 100644
--- a/docs/docker/Dockerfile
+++ b/docs/docker/Dockerfile
@@ -14,8 +14,15 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-FROM centos:centos7
+FROM ruby:2.3
-RUN yum install -y vim gem ruby-devel make gcc gcc-c++ python-setuptools && \
- gem install bundler
+# Debian Stretch is EOL - switch to archive mirrors
+RUN sed -i 's/deb.debian.org/archive.debian.org/g' /etc/apt/sources.list && \
+ sed -i 's/security.debian.org/archive.debian.org/g' /etc/apt/sources.list && \
+ sed -i '/stretch-updates/d' /etc/apt/sources.list
+
+RUN apt-get update && apt-get install -y --allow-unauthenticated \
+ build-essential \
+ && gem install bundler -v 1.17.3 \
+ && rm -rf /var/lib/apt/lists/*
(flink) 01/04: [hotfix][docs] Add docs.sh for legacy CI pipeline
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.2
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 1c23f821c7ab3ce236ff5613ee24cc3dcd2bafa4
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
(flink) 03/04: [FLINK-38925][docs] Update Matomo URL to the right domain
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch release-1.2
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 1c1466cdb47e3a262a8bd1101d702cf581d9b8ec
Author: Martijn Visser <29...@users.noreply.github.com>
AuthorDate: Tue Jan 20 10:37:07 2026 +0100
[FLINK-38925][docs] Update Matomo URL to the right domain
---
docs/_layouts/base.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 955da5d278c..b02997c62b1 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -64,7 +64,7 @@ under the License.
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
- var u="//matomo.privacy.apache.org/";
+ var u="//analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '1']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];