This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit b38cd662bcfe66dd467bfc88c4ec313f444c48fd
Author: Chesnay Schepler <ches...@apache.org>
AuthorDate: Fri Aug 11 12:36:55 2023 +0200
[FLINK-32834] Add documentation to the scripts
---
tools/ci/compile.sh | 17 ++++++++++++++++-
tools/ci/compile_ci.sh | 2 +-
2 files changed, 17 insertions(+), 2 deletions(-)
diff --git a/tools/ci/compile.sh b/tools/ci/compile.sh
index bc349e3d53a..ee4ba13d940 100755
--- a/tools/ci/compile.sh
+++ b/tools/ci/compile.sh
@@ -18,7 +18,22 @@
################################################################################
#
-# This file contains tooling for compiling Flink
+# This script compiles Flink and runs all QA checks apart from tests.
+#
+# This script should not contain any CI-specific logic; put these into
compile_ci.sh instead.
+#
+# Usage: [MVN=/path/to/maven] tools/ci/compile.sh [additional maven args]
+# - Use the MVN environment variable to point the script to another maven
installation.
+# - Any script argument is forwarded to the Flink maven build. Use it to
skip/modify parts of the build process.
+#
+# Tips:
+# - '-Pskip-webui-build' skips the WebUI build.
+# - '-Dfast' skips Maven QA checks.
+# - '-Dmaven.clean.skip' skips recompilation of classes.
+# Example: tools/ci/compile.sh -Dmaven.clean.skip -Dfast -Pskip-webui-build,
use -Dmaven.clean.skip to avoid recompiling classes.
+#
+# Warnings:
+# - Skipping modules via '-pl [!]<module>' is not recommended because checks
may assume/require a full build.
#
CI_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
diff --git a/tools/ci/compile_ci.sh b/tools/ci/compile_ci.sh
index d9b3f68a49a..d88cce6848d 100755
--- a/tools/ci/compile_ci.sh
+++ b/tools/ci/compile_ci.sh
@@ -18,7 +18,7 @@
################################################################################
#
-# This file contains tooling for compiling Flink
+# This script is the CI entrypoint for compiling Flink and running QA checks
that don't require tests.
#
CI_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
