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 2023/10/30 13:50:44 UTC
(flink-web) branch asf-site updated (86311d4a0 -> 95a7e0907)
This is an automated email from the ASF dual-hosted git repository.
mapohl pushed a change to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git
from 86311d4a0 Rebuild website
new 6b3d1b55f [FLINK-30768] Moves version configuration for quickstart scripts entirely into docs/config.toml
new 95a7e0907 Rebuild website
The 2 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:
_utils.sh => _include/q/_utils.sh | 28 ++++++++++++++++++----------
_include/q/gradle-quickstart.sh | 21 +++++++++++++++------
_include/q/quickstart-SNAPSHOT.sh | 5 ++++-
_include/q/quickstart.sh | 5 ++++-
_include/q/sbt-quickstart.sh | 16 +++++++++-------
_utils.sh => content/q/_utils.sh | 28 ++++++++++++++++++----------
content/q/gradle-quickstart.sh | 21 +++++++++++++++------
content/q/quickstart-SNAPSHOT.sh | 5 ++++-
content/q/quickstart.sh | 5 ++++-
content/q/sbt-quickstart.sh | 16 +++++++++-------
docs/config.toml | 3 +++
11 files changed, 103 insertions(+), 50 deletions(-)
copy _utils.sh => _include/q/_utils.sh (61%)
copy _utils.sh => content/q/_utils.sh (61%)
(flink-web) 01/02: [FLINK-30768] Moves version configuration for quickstart scripts entirely into docs/config.toml
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mapohl pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git
commit 6b3d1b55fc0516087e92bce403a7e2fd06b7f233
Author: yu <13485876233>
AuthorDate: Sun Oct 8 10:28:03 2023 +0800
[FLINK-30768] Moves version configuration for quickstart scripts entirely into docs/config.toml
---
_include/q/{quickstart.sh => _utils.sh} | 43 +++++++++++++++------------------
_include/q/gradle-quickstart.sh | 21 +++++++++++-----
_include/q/quickstart-SNAPSHOT.sh | 5 +++-
_include/q/quickstart.sh | 5 +++-
_include/q/sbt-quickstart.sh | 16 ++++++------
docs/config.toml | 3 +++
6 files changed, 54 insertions(+), 39 deletions(-)
diff --git a/_include/q/quickstart.sh b/_include/q/_utils.sh
similarity index 52%
copy from _include/q/quickstart.sh
copy to _include/q/_utils.sh
index ce14e8f91..0989fced6 100644
--- a/_include/q/quickstart.sh
+++ b/_include/q/_utils.sh
@@ -1,5 +1,4 @@
#!/usr/bin/env bash
-
################################################################################
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
@@ -18,29 +17,25 @@
# limitations under the License.
################################################################################
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+CONFIG_DIR="${SCRIPT_DIR}/../../docs/config.toml"
-PACKAGE=quickstart
+# fatal error handling
+export PROCESS_ID=$$
+trap 'exit 1' TERM
-mvn archetype:generate \
- -DarchetypeGroupId=org.apache.flink \
- -DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion=${1:-1.17.0} \
- -DgroupId=org.myorg.quickstart \
- -DartifactId=$PACKAGE \
- -Dversion=0.1 \
- -Dpackage=org.myorg.quickstart \
- -DinteractiveMode=false
+function extract_parameter() {
+ if [[ "$#" != 1 ]]; then
+ trigger_fatal_error "Fatal error: No parameter or too many parameters passed: $@"
+ fi
+ parameter_value="$(awk -F'"' '/'$1'[ ]*=[ ]*"/{print $2}' $CONFIG_DIR)"
+ if [ "$parameter_value" = "" ]; then
+ trigger_fatal_error "Fatal error: $1 parameter no found valid value."
+ fi
+ echo ${parameter_value}
+}
-#
-# Give some guidance
-#
-echo -e "\\n\\n"
-echo -e "\\tA sample quickstart Flink Job has been created."
-echo -e "\\tSwitch into the directory using"
-echo -e "\\t\\t cd $PACKAGE"
-echo -e "\\tImport the project there using your favorite IDE (Import it as a maven project)"
-echo -e "\\tBuild a jar inside the directory using"
-echo -e "\\t\\t mvn clean package"
-echo -e "\\tYou will find the runnable jar in $PACKAGE/target"
-echo -e "\\tConsult our website if you have any troubles: http://flink.apache.org/community.html#mailing-lists"
-echo -e "\\n\\n"
+function trigger_fatal_error() {
+ echo $1 >&2
+ kill -s TERM $PROCESS_ID
+}
\ No newline at end of file
diff --git a/_include/q/gradle-quickstart.sh b/_include/q/gradle-quickstart.sh
index b8cec12cb..b7a6209fd 100644
--- a/_include/q/gradle-quickstart.sh
+++ b/_include/q/gradle-quickstart.sh
@@ -18,6 +18,8 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
+
declare -r TRUE=0
declare -r FALSE=1
@@ -41,11 +43,15 @@ function mkPackage() {
defaultProjectName="quickstart"
defaultOrganization="org.myorg.quickstart"
defaultVersion="0.1-SNAPSHOT"
-defaultFlinkVersion="${1:-1.17.0}"
+defaultFlinkVersion="$(extract_parameter 'FlinkStableVersion')"
+defaultFlinkShortVersion="$(extract_parameter 'FlinkStableShortVersion')"
+flinkVersionFromParameter="${1:-$defaultFlinkVersion}"
# flink-docs-master/docs/dev/datastream/project-configuration/#gradle
# passes the scala version prefixed with a _, e.g.: _2.12
+defaultScalaShortVersion="$(extract_parameter 'ScalaShortVersion')"
scalaBinaryVersionFromCmdArg="${2/_/}"
-defaultScalaBinaryVersion="${scalaBinaryVersionFromCmdArg:-2.12}"
+defaultScalaBinaryVersion="${scalaBinaryVersionFromCmdArg:-$defaultScalaShortVersion}"
+defaultJavaVersion="$(extract_parameter 'JavaVersion')"
echo "This script creates a Flink project using Java and Gradle."
@@ -58,10 +64,12 @@ while [ $TRUE ]; do
organization=${organization:-$defaultOrganization}
read -p "Version ($defaultVersion): " version
version=${version:-$defaultVersion}
- read -p "Flink version ($defaultFlinkVersion): " flinkVersion
- flinkVersion=${flinkVersion:-$defaultFlinkVersion}
+ read -p "Flink version ($flinkVersionFromParameter): " flinkVersion
+ flinkVersion=${flinkVersion:-$flinkVersionFromParameter}
read -p "Scala version ($defaultScalaBinaryVersion): " scalaBinaryVersion
scalaBinaryVersion=${scalaBinaryVersion:-$defaultScalaBinaryVersion}
+ read -p "Java version ($defaultJavaVersion): " javaVersion
+ javaVersion=${javaVersion:-$defaultJavaVersion}
echo ""
echo "-----------------------------------------------"
@@ -70,6 +78,7 @@ while [ $TRUE ]; do
echo "Version: ${version}"
echo "Scala binary version: ${scalaBinaryVersion}"
echo "Flink version: ${flinkVersion}"
+ echo "Java version: ${javaVersion}"
echo "-----------------------------------------------"
read -p "Create Project? (Y/n): " createProject
createProject=${createProject:-y}
@@ -111,12 +120,12 @@ plugins {
}
ext {
- javaVersion = '1.8'
+ javaVersion = '${javaVersion}'
flinkVersion = '${flinkVersion}'
scalaBinaryVersion = '${scalaBinaryVersion}'
slf4jVersion = '1.7.36'
log4jVersion = '2.17.1'
- flinkVersionNew = flinkVersion.toString().replace("-SNAPSHOT", "") >= "1.17"
+ flinkVersionNew = flinkVersion.toString().replace("-SNAPSHOT", "") >= "${defaultFlinkShortVersion}"
}
// artifact properties
diff --git a/_include/q/quickstart-SNAPSHOT.sh b/_include/q/quickstart-SNAPSHOT.sh
index bf4f3a4db..bd0038c0b 100644
--- a/_include/q/quickstart-SNAPSHOT.sh
+++ b/_include/q/quickstart-SNAPSHOT.sh
@@ -18,13 +18,16 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
PACKAGE=quickstart
+defaultFlinkVersionSnapShot="$(extract_parameter 'FlinkStableShortVersion')-SNAPSHOT"
+
mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
-DarchetypeGroupId=org.apache.flink \
-DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion=${1:-1.17-SNAPSHOT} \
+ -DarchetypeVersion=${1:-${defaultFlinkVersionSnapShot}} \
-DgroupId=org.myorg.quickstart \
-DartifactId=$PACKAGE \
-Dversion=0.1 \
diff --git a/_include/q/quickstart.sh b/_include/q/quickstart.sh
index ce14e8f91..3b34813c5 100644
--- a/_include/q/quickstart.sh
+++ b/_include/q/quickstart.sh
@@ -18,13 +18,16 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
PACKAGE=quickstart
+defaultFlinkVersion="$(extract_parameter 'FlinkStableVersion')"
+
mvn archetype:generate \
-DarchetypeGroupId=org.apache.flink \
-DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion=${1:-1.17.0} \
+ -DarchetypeVersion=${1:-${defaultFlinkVersion}} \
-DgroupId=org.myorg.quickstart \
-DartifactId=$PACKAGE \
-Dversion=0.1 \
diff --git a/_include/q/sbt-quickstart.sh b/_include/q/sbt-quickstart.sh
index 7973e0de2..b64c3d994 100644
--- a/_include/q/sbt-quickstart.sh
+++ b/_include/q/sbt-quickstart.sh
@@ -18,6 +18,8 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
+
declare -r TRUE=0
declare -r FALSE=1
@@ -41,8 +43,8 @@ function mkPackage() {
defaultProjectName="Flink Project"
defaultOrganization="org.example"
defaultVersion="0.1-SNAPSHOT"
-defaultScalaVersion="2.12.7"
-defaultFlinkVersion="1.17.0"
+defaultScalaVersion="$(extract_parameter 'ScalaVersion')"
+defaultFlinkVersion="$(extract_parameter 'FlinkStableVersion')"
echo "This script creates a Flink project using Scala and SBT."
@@ -97,15 +99,15 @@ echo "ThisBuild / resolvers ++= Seq(
Resolver.mavenLocal
)
-name := \"Flink Project\"
+name := \"$projectName\"
-version := \"0.1-SNAPSHOT\"
+version := \"$version\"
-organization := \"org.example\"
+organization := \"$organization\"
-ThisBuild / scalaVersion := \"2.12.7\"
+ThisBuild / scalaVersion := \"$scalaVersion\"
-val flinkVersion = \"1.16.1\"
+val flinkVersion = \"$flinkVersion\"
val flinkDependencies = Seq(
\"org.apache.flink\" %% \"flink-scala\" % flinkVersion % \"provided\",
diff --git a/docs/config.toml b/docs/config.toml
index 2b6f951e0..9704e05bf 100644
--- a/docs/config.toml
+++ b/docs/config.toml
@@ -43,6 +43,9 @@ posts = "/:year/:month/:day/:title/"
FlinkKubernetesOperatorStableShortVersion = "1.6"
FlinkTableStoreStableVersion = "0.3.0"
FlinkTableStoreStableShortVersion = "0.3"
+ ScalaVersion = "2.12.7"
+ ScalaShortVersion = "2.12"
+ JavaVersion = "1.8"
# External links at the bottom
# of the menu
(flink-web) 02/02: Rebuild website
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mapohl pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git
commit 95a7e090795e51f92bd5b073746462b837f5ac1b
Author: Matthias Pohl <ma...@aiven.io>
AuthorDate: Mon Oct 30 14:48:44 2023 +0100
Rebuild website
---
content/q/{quickstart.sh => _utils.sh} | 43 +++++++++++++++-------------------
content/q/gradle-quickstart.sh | 21 ++++++++++++-----
content/q/quickstart-SNAPSHOT.sh | 5 +++-
content/q/quickstart.sh | 5 +++-
content/q/sbt-quickstart.sh | 16 +++++++------
5 files changed, 51 insertions(+), 39 deletions(-)
diff --git a/content/q/quickstart.sh b/content/q/_utils.sh
similarity index 52%
copy from content/q/quickstart.sh
copy to content/q/_utils.sh
index ce14e8f91..0989fced6 100644
--- a/content/q/quickstart.sh
+++ b/content/q/_utils.sh
@@ -1,5 +1,4 @@
#!/usr/bin/env bash
-
################################################################################
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
@@ -18,29 +17,25 @@
# limitations under the License.
################################################################################
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+CONFIG_DIR="${SCRIPT_DIR}/../../docs/config.toml"
-PACKAGE=quickstart
+# fatal error handling
+export PROCESS_ID=$$
+trap 'exit 1' TERM
-mvn archetype:generate \
- -DarchetypeGroupId=org.apache.flink \
- -DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion=${1:-1.17.0} \
- -DgroupId=org.myorg.quickstart \
- -DartifactId=$PACKAGE \
- -Dversion=0.1 \
- -Dpackage=org.myorg.quickstart \
- -DinteractiveMode=false
+function extract_parameter() {
+ if [[ "$#" != 1 ]]; then
+ trigger_fatal_error "Fatal error: No parameter or too many parameters passed: $@"
+ fi
+ parameter_value="$(awk -F'"' '/'$1'[ ]*=[ ]*"/{print $2}' $CONFIG_DIR)"
+ if [ "$parameter_value" = "" ]; then
+ trigger_fatal_error "Fatal error: $1 parameter no found valid value."
+ fi
+ echo ${parameter_value}
+}
-#
-# Give some guidance
-#
-echo -e "\\n\\n"
-echo -e "\\tA sample quickstart Flink Job has been created."
-echo -e "\\tSwitch into the directory using"
-echo -e "\\t\\t cd $PACKAGE"
-echo -e "\\tImport the project there using your favorite IDE (Import it as a maven project)"
-echo -e "\\tBuild a jar inside the directory using"
-echo -e "\\t\\t mvn clean package"
-echo -e "\\tYou will find the runnable jar in $PACKAGE/target"
-echo -e "\\tConsult our website if you have any troubles: http://flink.apache.org/community.html#mailing-lists"
-echo -e "\\n\\n"
+function trigger_fatal_error() {
+ echo $1 >&2
+ kill -s TERM $PROCESS_ID
+}
\ No newline at end of file
diff --git a/content/q/gradle-quickstart.sh b/content/q/gradle-quickstart.sh
index b8cec12cb..b7a6209fd 100644
--- a/content/q/gradle-quickstart.sh
+++ b/content/q/gradle-quickstart.sh
@@ -18,6 +18,8 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
+
declare -r TRUE=0
declare -r FALSE=1
@@ -41,11 +43,15 @@ function mkPackage() {
defaultProjectName="quickstart"
defaultOrganization="org.myorg.quickstart"
defaultVersion="0.1-SNAPSHOT"
-defaultFlinkVersion="${1:-1.17.0}"
+defaultFlinkVersion="$(extract_parameter 'FlinkStableVersion')"
+defaultFlinkShortVersion="$(extract_parameter 'FlinkStableShortVersion')"
+flinkVersionFromParameter="${1:-$defaultFlinkVersion}"
# flink-docs-master/docs/dev/datastream/project-configuration/#gradle
# passes the scala version prefixed with a _, e.g.: _2.12
+defaultScalaShortVersion="$(extract_parameter 'ScalaShortVersion')"
scalaBinaryVersionFromCmdArg="${2/_/}"
-defaultScalaBinaryVersion="${scalaBinaryVersionFromCmdArg:-2.12}"
+defaultScalaBinaryVersion="${scalaBinaryVersionFromCmdArg:-$defaultScalaShortVersion}"
+defaultJavaVersion="$(extract_parameter 'JavaVersion')"
echo "This script creates a Flink project using Java and Gradle."
@@ -58,10 +64,12 @@ while [ $TRUE ]; do
organization=${organization:-$defaultOrganization}
read -p "Version ($defaultVersion): " version
version=${version:-$defaultVersion}
- read -p "Flink version ($defaultFlinkVersion): " flinkVersion
- flinkVersion=${flinkVersion:-$defaultFlinkVersion}
+ read -p "Flink version ($flinkVersionFromParameter): " flinkVersion
+ flinkVersion=${flinkVersion:-$flinkVersionFromParameter}
read -p "Scala version ($defaultScalaBinaryVersion): " scalaBinaryVersion
scalaBinaryVersion=${scalaBinaryVersion:-$defaultScalaBinaryVersion}
+ read -p "Java version ($defaultJavaVersion): " javaVersion
+ javaVersion=${javaVersion:-$defaultJavaVersion}
echo ""
echo "-----------------------------------------------"
@@ -70,6 +78,7 @@ while [ $TRUE ]; do
echo "Version: ${version}"
echo "Scala binary version: ${scalaBinaryVersion}"
echo "Flink version: ${flinkVersion}"
+ echo "Java version: ${javaVersion}"
echo "-----------------------------------------------"
read -p "Create Project? (Y/n): " createProject
createProject=${createProject:-y}
@@ -111,12 +120,12 @@ plugins {
}
ext {
- javaVersion = '1.8'
+ javaVersion = '${javaVersion}'
flinkVersion = '${flinkVersion}'
scalaBinaryVersion = '${scalaBinaryVersion}'
slf4jVersion = '1.7.36'
log4jVersion = '2.17.1'
- flinkVersionNew = flinkVersion.toString().replace("-SNAPSHOT", "") >= "1.17"
+ flinkVersionNew = flinkVersion.toString().replace("-SNAPSHOT", "") >= "${defaultFlinkShortVersion}"
}
// artifact properties
diff --git a/content/q/quickstart-SNAPSHOT.sh b/content/q/quickstart-SNAPSHOT.sh
index bf4f3a4db..bd0038c0b 100644
--- a/content/q/quickstart-SNAPSHOT.sh
+++ b/content/q/quickstart-SNAPSHOT.sh
@@ -18,13 +18,16 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
PACKAGE=quickstart
+defaultFlinkVersionSnapShot="$(extract_parameter 'FlinkStableShortVersion')-SNAPSHOT"
+
mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
-DarchetypeGroupId=org.apache.flink \
-DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion=${1:-1.17-SNAPSHOT} \
+ -DarchetypeVersion=${1:-${defaultFlinkVersionSnapShot}} \
-DgroupId=org.myorg.quickstart \
-DartifactId=$PACKAGE \
-Dversion=0.1 \
diff --git a/content/q/quickstart.sh b/content/q/quickstart.sh
index ce14e8f91..3b34813c5 100644
--- a/content/q/quickstart.sh
+++ b/content/q/quickstart.sh
@@ -18,13 +18,16 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
PACKAGE=quickstart
+defaultFlinkVersion="$(extract_parameter 'FlinkStableVersion')"
+
mvn archetype:generate \
-DarchetypeGroupId=org.apache.flink \
-DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion=${1:-1.17.0} \
+ -DarchetypeVersion=${1:-${defaultFlinkVersion}} \
-DgroupId=org.myorg.quickstart \
-DartifactId=$PACKAGE \
-Dversion=0.1 \
diff --git a/content/q/sbt-quickstart.sh b/content/q/sbt-quickstart.sh
index 7973e0de2..b64c3d994 100644
--- a/content/q/sbt-quickstart.sh
+++ b/content/q/sbt-quickstart.sh
@@ -18,6 +18,8 @@
# limitations under the License.
################################################################################
+source "$(dirname "$0")"/_utils.sh
+
declare -r TRUE=0
declare -r FALSE=1
@@ -41,8 +43,8 @@ function mkPackage() {
defaultProjectName="Flink Project"
defaultOrganization="org.example"
defaultVersion="0.1-SNAPSHOT"
-defaultScalaVersion="2.12.7"
-defaultFlinkVersion="1.17.0"
+defaultScalaVersion="$(extract_parameter 'ScalaVersion')"
+defaultFlinkVersion="$(extract_parameter 'FlinkStableVersion')"
echo "This script creates a Flink project using Scala and SBT."
@@ -97,15 +99,15 @@ echo "ThisBuild / resolvers ++= Seq(
Resolver.mavenLocal
)
-name := \"Flink Project\"
+name := \"$projectName\"
-version := \"0.1-SNAPSHOT\"
+version := \"$version\"
-organization := \"org.example\"
+organization := \"$organization\"
-ThisBuild / scalaVersion := \"2.12.7\"
+ThisBuild / scalaVersion := \"$scalaVersion\"
-val flinkVersion = \"1.16.1\"
+val flinkVersion = \"$flinkVersion\"
val flinkDependencies = Seq(
\"org.apache.flink\" %% \"flink-scala\" % flinkVersion % \"provided\",