You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by gu...@apache.org on 2024/08/02 08:55:42 UTC
(flink) branch test-doc updated (785baf4665d -> 380b5a5d2e9)
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a change to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
discard 785baf4665d update toml
discard 853bf58e360 fixup! test 120
discard 388c95e82dd test 120
discard 462110523a3 upload file
discard b36b5320d9f change branch
discard 3a3eaa2460d new sh
discard 87b5e18516f fixup! fixup! only trigger on 1.20 for testing
discard d54a9df5c96 fixup! only trigger on 1.20 for testing
discard f42fbe51b58 only trigger on 1.20 for testing
discard 9d18b5d5e7a fixup! try to downgrade maven-javadoc-plugin to `2.10.4`
discard 1ef699475c1 try to downgrade maven-javadoc-plugin to `2.10.4`
add b9042e4df28 [FLINK-35847][release] Add release note for version 1.20
add 1fa4ad60fb5 [hotfix][doc] skip npm for doc building
new 958734a067a try to downgrade maven-javadoc-plugin to `2.10.4`
new 5aa2a8f6a5a fixup! try to downgrade maven-javadoc-plugin to `2.10.4`
new 896339b1dcf only trigger on 1.20 for testing
new cd87e3b8de9 fixup! fixup! only trigger on 1.20 for testing
new c52c5dd251a new sh
new 16d95685723 change branch
new b57756788ab upload file
new 2401faab38a test 120
new c7645b8055f fixup! test 120
new 380b5a5d2e9 update toml
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (785baf4665d)
\
N -- N -- N refs/heads/test-doc (380b5a5d2e9)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 10 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:
docs/content.zh/_index.md | 3 +-
docs/content.zh/release-notes/flink-1.20.md | 433 ++++++++++++++++++++++++++++
docs/content/_index.md | 1 +
docs/content/release-notes/flink-1.20.md | 433 ++++++++++++++++++++++++++++
4 files changed, 869 insertions(+), 1 deletion(-)
create mode 100644 docs/content.zh/release-notes/flink-1.20.md
create mode 100644 docs/content/release-notes/flink-1.20.md
(flink) 05/10: new sh
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit c52c5dd251adc888ca6eda441e6db73ba3a9169e
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 11:38:08 2024 +0800
new sh
---
.github/workflows/docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 21c31e88c6c..3f60d411885 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -45,7 +45,7 @@ jobs:
fi
- name: Build documentation
run: |
- docker run --rm --volume "$PWD:/root/flink" chesnay/flink-ci:java_8_11_17_21_maven_386 bash -c "cd /root/flink && ./.github/workflows/docs.sh"
+ docker run --rm --volume "$PWD:/root/flink" chesnay/flink-ci:java_8_11_17_21_maven_386 bash -c "cd /root/flink && ./.github/workflows/docs-new.sh"
- name: Upload documentation
uses: burnett01/rsync-deployments@5.2
with:
(flink) 04/10: fixup! fixup! only trigger on 1.20 for testing
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit cd87e3b8de997c967cebed9622fed5706216f255
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 10:49:53 2024 +0800
fixup! fixup! only trigger on 1.20 for testing
---
.github/workflows/docs.sh | 2 ++
1 file changed, 2 insertions(+)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
index 1ce2661c552..ad128852d4a 100755
--- a/.github/workflows/docs.sh
+++ b/.github/workflows/docs.sh
@@ -46,8 +46,10 @@ if [ $? -ne 0 ]; then
exit 1
fi
+echo "build Flink; required for Javadoc step"
# build Flink; required for Javadoc step
mvn clean install -B -DskipTests -Dfast -Dskip.npm -Pskip-webui-build
+echo "finish build Flink"
# build java/scala docs
mkdir -p docs/target/api
(flink) 06/10: change branch
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 16d95685723e67270636c20785981500250bd643
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 11:47:38 2024 +0800
change branch
---
.github/workflows/docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 3f60d411885..ab927b3dc07 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -27,7 +27,7 @@ jobs:
max-parallel: 1
matrix:
branch:
- - release-1.20
+ - test-doc
steps:
- uses: actions/checkout@v3
with:
(flink) 03/10: only trigger on 1.20 for testing
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 896339b1dcfe6a0a53749cc5b58f79e9f0bd0708
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 10:17:37 2024 +0800
only trigger on 1.20 for testing
---
.github/workflows/docs.yml | 4 ----
1 file changed, 4 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 6c3369b4b19..21c31e88c6c 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -27,11 +27,7 @@ jobs:
max-parallel: 1
matrix:
branch:
- - master
- release-1.20
- - release-1.19
- - release-1.18
- - release-1.17
steps:
- uses: actions/checkout@v3
with:
(flink) 09/10: fixup! test 120
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit c7645b8055fafa0c332b79a35d24a701f0b17998
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 16:02:23 2024 +0800
fixup! test 120
---
.github/workflows/docs.yml | 1 -
1 file changed, 1 deletion(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 09a981c96b2..f455e1828c4 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -39,7 +39,6 @@ jobs:
echo "flink_branch=release-1.20" >> ${GITHUB_ENV}
echo "flink_alias=release-1.20" >> ${GITHUB_ENV}
- fi
- name: Build documentation
run: |
docker run --rm --volume "$PWD:/root/flink" chesnay/flink-ci:java_8_11_17_21_maven_386 bash -c "cd /root/flink && ./.github/workflows/docs-new.sh"
(flink) 07/10: upload file
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit b57756788abf040828f13cc8db31538a36d18057
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 11:53:07 2024 +0800
upload file
---
.github/workflows/docs-new.sh | 82 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 82 insertions(+)
diff --git a/.github/workflows/docs-new.sh b/.github/workflows/docs-new.sh
new file mode 100755
index 00000000000..14a00a0fd0a
--- /dev/null
+++ b/.github/workflows/docs-new.sh
@@ -0,0 +1,82 @@
+#!/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
+set -x
+echo "new doc build"
+mvn --version
+java -version
+javadoc -J-version
+
+# workaround for a git security patch
+git config --global --add safe.directory /root/flink
+git submodule update --init --recursive
+
+cd docs
+
+# setup hugo
+source setup_hugo.sh
+
+# Setup the external documentation modules
+source setup_docs.sh
+
+cd ..
+
+# Build the docs
+hugo --source docs
+
+# generate docs into docs/target
+hugo -v --source docs --destination target
+if [ $? -ne 0 ]; then
+ echo "Error building the docs"
+ exit 1
+fi
+
+echo "build Flink; required for Javadoc step"
+# build Flink; required for Javadoc step
+mvn clean install -B -DskipTests -Dfast -Dskip.npm -Pskip-webui-build
+echo "finish build Flink"
+
+# build java/scala docs
+mkdir -p docs/target/api
+mvn javadoc:aggregate -B \
+ -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=\"//matomo.privacy.apache.org/\";_paq.push([\"setTrackerUrl\",u+\"matomo.php\"]),_paq.push([\"setSiteId\",\"1\"]);var d=document, g=d.createEle [...]
+mv target/site/apidocs docs/target/api/java
+mvn -pl flink-scala scala:doc -B \
+ -Dcheckstyle.skip=true \
+ -Dspotless.skip=true \
+ -Denforcer.skip=true
+mv flink-scala/target/site/scaladocs docs/target/api/scala
+
+# build python docs
+if [ -f ./flink-python/dev/lint-python.sh ]; then
+ # Just completely ignore sudo in conda.
+ unset SUDO_UID SUDO_GID SUDO_USER
+
+ # build python docs
+ # disable the gateway, because otherwise it tries to find FLINK_HOME to access Java classes
+ PYFLINK_GATEWAY_DISABLED=1 ./flink-python/dev/lint-python.sh -i "sphinx"
+
+ # move python docs
+ mv flink-python/docs/_build/html docs/target/api/python
+fi
(flink) 08/10: test 120
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 2401faab38a753618fee76ea5d36a054dc4f86fe
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 15:58:14 2024 +0800
test 120
---
.github/workflows/docs.yml | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index ab927b3dc07..09a981c96b2 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -36,12 +36,9 @@ jobs:
run: |
currentBranch=$(git branch --show-current)
- echo "flink_branch=${currentBranch}" >> ${GITHUB_ENV}
+ echo "flink_branch=release-1.20" >> ${GITHUB_ENV}
- if [ "${currentBranch}" = "master" ]; then
- echo "flink_alias=release-1.20" >> ${GITHUB_ENV}
- elif [ "${currentBranch}" = "release-1.19" ]; then
- echo "flink_alias=stable" >> ${GITHUB_ENV}
+ echo "flink_alias=release-1.20" >> ${GITHUB_ENV}
fi
- name: Build documentation
run: |
(flink) 10/10: update toml
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 380b5a5d2e92e50a6d226bed70357cf414eb9e9b
Author: Weijie Guo <re...@163.com>
AuthorDate: Fri Aug 2 16:43:11 2024 +0800
update toml
---
docs/config.toml | 23 ++++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/docs/config.toml b/docs/config.toml
index 0fb4a4e02c2..a38ca00f075 100644
--- a/docs/config.toml
+++ b/docs/config.toml
@@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-baseURL = '//nightlies.apache.org/flink/flink-docs-master'
+baseURL = '//nightlies.apache.org/flink/flink-docs-release-1.20'
languageCode = "en-us"
title = "Apache Flink"
enableGitInfo = false
@@ -24,7 +24,7 @@ pygmentsUseClasses = true
[params]
# Flag whether this is a stable version or not.
# Used for the quickstart page.
- IsStable = false
+ IsStable = true
# Flag to indicate whether an outdated warning should be shown.
ShowOutDatedWarning = false
@@ -34,14 +34,14 @@ pygmentsUseClasses = true
# we change the version for the complete docs when forking of a release branch
# etc.
# The full version string as referenced in Maven (e.g. 1.2.1)
- Version = "2.0-SNAPSHOT"
+ Version = "1.20.0"
# For stable releases, leave the bugfix version out (e.g. 1.2). For snapshot
# release this should be the same as the regular version
- VersionTitle = "2.0-SNAPSHOT"
+ VersionTitle = "1.20"
# The branch for this version of Apache Flink
- Branch = "master"
+ Branch = "release-1.20"
# The github repository for Apache Flink
Repo = "//github.com/apache/flink"
@@ -60,22 +60,23 @@ pygmentsUseClasses = true
ZhDownloadPage = "//flink.apache.org/zh/downloads.html"
- JavaDocs = "//nightlies.apache.org/flink/flink-docs-master/api/java/"
+ JavaDocs = "//nightlies.apache.org/flink/flink-docs-release-1.20/api/java/"
- ScalaDocs = "//nightlies.apache.org/flink/flink-docs-master/api/scala/index.html#org.apache.flink.api.scala.package"
+ ScalaDocs = "//nightlies.apache.org/flink/flink-docs-release-1.20/api/scala/index.html#org.apache.flink.api.scala.package"
- PyDocs = "//nightlies.apache.org/flink/flink-docs-master/api/python/"
+ PyDocs = "//nightlies.apache.org/flink/flink-docs-release-1.20/api/python/"
# External links at the bottom
# of the menu
MenuLinks = [
["Project Homepage", "//flink.apache.org"],
- ["JavaDocs", "//nightlies.apache.org/flink/flink-docs-master/api/java/"],
- ["ScalaDocs", "//nightlies.apache.org/flink/flink-docs-master/api/scala/index.html#org.apache.flink.api.scala.package"],
- ["PyDocs", "//nightlies.apache.org/flink/flink-docs-master/api/python/"]
+ ["JavaDocs", "//nightlies.apache.org/flink/flink-docs-release-1.20/api/java/"],
+ ["ScalaDocs", "//nightlies.apache.org/flink/flink-docs-release-1.20/api/scala/index.html#org.apache.flink.api.scala.package/"],
+ ["PyDocs", "//nightlies.apache.org/flink/flink-docs-release-1.20/api/python/"]
]
PreviousDocs = [
+ ["1.20", "http://nightlies.apache.org/flink/flink-docs-release-1.20"],
["1.19", "http://nightlies.apache.org/flink/flink-docs-release-1.19"],
["1.18", "http://nightlies.apache.org/flink/flink-docs-release-1.18"],
["1.17", "http://nightlies.apache.org/flink/flink-docs-release-1.17"],
(flink) 02/10: fixup! try to downgrade maven-javadoc-plugin to `2.10.4`
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 5aa2a8f6a5ac0e63c92dd42db952ab2d9d12e443
Author: Weijie Guo <re...@163.com>
AuthorDate: Thu Jul 18 13:34:48 2024 +0800
fixup! try to downgrade maven-javadoc-plugin to `2.10.4`
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index 728ac433948..985a713c1d0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2238,7 +2238,7 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.4</version><!--$NO-MVN-MAN-VER$-->
+ <version>2.9.1</version><!--$NO-MVN-MAN-VER$-->
<configuration>
<quiet>true</quiet>
<detectOfflineLinks>false</detectOfflineLinks>
(flink) 01/10: try to downgrade maven-javadoc-plugin to `2.10.4`
Posted by gu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
guoweijie pushed a commit to branch test-doc
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 958734a067add8e8cfb5c7a3abf0572bdf740824
Author: Weijie Guo <re...@163.com>
AuthorDate: Thu Jul 18 12:05:32 2024 +0800
try to downgrade maven-javadoc-plugin to `2.10.4`
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index b8609a1d895..728ac433948 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2238,7 +2238,7 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>3.7.0</version><!--$NO-MVN-MAN-VER$-->
+ <version>2.10.4</version><!--$NO-MVN-MAN-VER$-->
<configuration>
<quiet>true</quiet>
<detectOfflineLinks>false</detectOfflineLinks>