You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by mb...@apache.org on 2022/03/16 14:09:21 UTC
[flink-kubernetes-operator] branch main updated: [FLINK-26612] Documentation build via GitHub actions
This is an automated email from the ASF dual-hosted git repository.
mbalassi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 394df8f [FLINK-26612] Documentation build via GitHub actions
394df8f is described below
commit 394df8fb3ad72ffa121b3b970d5271d2235073dd
Author: Marton Balassi <ma...@apple.com>
AuthorDate: Tue Mar 15 21:28:43 2022 +0100
[FLINK-26612] Documentation build via GitHub actions
Based on zentol's work in https://github.com/apache/flink/pull/19103/commits/54678bbe907d6f0dc70da226b0209e38fa06c59e.
---
{tools/ci => .github/workflows}/docs.sh | 24 +++++++++++---
.github/workflows/docs.yaml | 59 +++++++++++++++++++++++++++++++++
2 files changed, 78 insertions(+), 5 deletions(-)
diff --git a/tools/ci/docs.sh b/.github/workflows/docs.sh
similarity index 56%
rename from tools/ci/docs.sh
rename to .github/workflows/docs.sh
index c54f25a..7ee71be 100755
--- a/tools/ci/docs.sh
+++ b/.github/workflows/docs.sh
@@ -16,22 +16,36 @@
# See the License for the specific language governing permissions and
# limitations under the License.
################################################################################
+set -e
+export JAVA_HOME=$JAVA_HOME_11_X64
+
+# setup hugo
HUGO_REPO=https://github.com/gohugoio/hugo/releases/download/v0.80.0/hugo_extended_0.80.0_Linux-64bit.tar.gz
HUGO_ARTIFACT=hugo_extended_0.80.0_Linux-64bit.tar.gz
-
if ! curl --fail -OL $HUGO_REPO ; then
echo "Failed to download Hugo binary"
exit 1
fi
-
-tar -zxvf $HUGO_ARTIFACT hugo
-
+tar -zxvf $HUGO_ARTIFACT
git submodule update --init --recursive
# generate docs into docs/target
./hugo -v --source docs --destination target
-
if [ $? -ne 0 ]; then
echo "Error building the docs"
exit 1
fi
+
+# build Flink Operator; required for Javadoc step
+#mvn clean install -B -DskipTests
+
+# build Java 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.createEl [...]
+#mv target/site/apidocs docs/target/api/java
\ No newline at end of file
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
new file mode 100644
index 0000000..75a3f63
--- /dev/null
+++ b/.github/workflows/docs.yaml
@@ -0,0 +1,59 @@
+# 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.
+
+name: "Build documentation"
+on:
+ workflow_dispatch:
+jobs:
+ build-documentation:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@main
+ - name: Set branch environment variable
+ run: |
+ git branch --show-current
+ ls
+ currentBranch=$(git branch --show-current)
+ echo "flink_branch=${currentBranch}"
+ echo "flink_branch=${currentBranch}" >> ${GITHUB_ENV}
+ if [ "${currentBranch} = "main" ]; then
+ echo "flink_alias=release-1.0" >> ${GITHUB_ENV}
+ elif [ "${currentBranch} = "release-1.14" ]; then
+ echo "flink_alias=stable" >> ${GITHUB_ENV}
+ fi
+ - name: Build documentation
+ run: |
+ docker run --rm --volume "$PWD:/root/flink-kubernetes-operator" chesnay/flink-ci:java_8_11 bash -c "cd /root/flink-kubernetes-operator && ./.github/workflows/docs.sh"
+ - name: Upload documentation
+ uses: burnett01/rsync-deployments@5.2
+ with:
+ switches: --archive --compress
+ path: docs/target/
+ remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink/testing-flink-kubernetes-operator-docs-${{ env.flink_branch }}/
+ remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
+ remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
+ remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
+ remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}
+ - name: Upload documentation alias
+ if: env.flink_alias != ''
+ uses: burnett01/rsync-deployments@5.2
+ with:
+ switches: --archive --compress
+ path: docs/target/
+ remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink/testing-flink-kubernetes-operator-docs-${{ env.flink_alias }}/
+ remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
+ remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
+ remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
+ remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}
\ No newline at end of file