This is an automated email from the ASF dual-hosted git repository.
timbrown pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-xtable.git
The following commit(s) were added to refs/heads/main by this push:
new 50ae6116 [787] Add maven wrapper for consistent builds (#788)
50ae6116 is described below
commit 50ae6116788cb792db2997969076f0702e8a40ab
Author: Tim Brown <[email protected]>
AuthorDate: Fri Jan 16 16:17:47 2026 -0500
[787] Add maven wrapper for consistent builds (#788)
* add a maven wrapper for consistent builds
* update readme and docs to prefer mvnw for consistent builds
* update more mvn usage
* update deploy_staging_jars
---
.github/workflows/mvn-ci-build.yml | 2 +-
.github/workflows/mvn-license-check.yml | 2 +-
.github/workflows/package-deploy.yml | 4 +-
.../wrapper/maven-wrapper.properties | 7 +-
Dockerfile | 8 +-
README.md | 14 +-
demo/start_demo.sh | 2 +-
mvnw | 295 +++++++++++++++++++++
mvnw.cmd | 189 +++++++++++++
release/release_guide.md | 8 +-
release/scripts/cut_release_branch.sh | 4 +-
release/scripts/deploy_staging_jars.sh | 2 +-
release/scripts/validate_source_rat.sh | 2 +-
website/docs/setup.md | 4 +-
xtable-service/README.md | 4 +-
15 files changed, 515 insertions(+), 32 deletions(-)
diff --git a/.github/workflows/mvn-ci-build.yml
b/.github/workflows/mvn-ci-build.yml
index 218d8dee..6b51ce66 100644
--- a/.github/workflows/mvn-ci-build.yml
+++ b/.github/workflows/mvn-ci-build.yml
@@ -44,4 +44,4 @@ jobs:
cache: maven
- name: Build all module with Maven
- run: mvn clean install -ntp -B
+ run: ./mvnw clean install -ntp -B
diff --git a/.github/workflows/mvn-license-check.yml
b/.github/workflows/mvn-license-check.yml
index ca7e9b7d..f032521a 100644
--- a/.github/workflows/mvn-license-check.yml
+++ b/.github/workflows/mvn-license-check.yml
@@ -43,4 +43,4 @@ jobs:
cache: maven
- name: Apache License Check
- run: mvn apache-rat:check -B
+ run: ./mvnw apache-rat:check -B
diff --git a/.github/workflows/package-deploy.yml
b/.github/workflows/package-deploy.yml
index a39bed97..d3a9871a 100644
--- a/.github/workflows/package-deploy.yml
+++ b/.github/workflows/package-deploy.yml
@@ -33,8 +33,8 @@ jobs:
- name: Parse Version Number
run: echo "VERSION=$(echo ${{ github.event.release.tag_name }} | sed
-e s/v//)" >> $GITHUB_ENV
- name: Set Version
- run: mvn versions:set -DnewVersion="$VERSION"
+ run: ./mvnw versions:set -DnewVersion="$VERSION"
- name: Publish package
- run: mvn -ntp --batch-mode deploy -DskipTests
+ run: ./mvnw -ntp --batch-mode deploy -DskipTests
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
\ No newline at end of file
diff --git a/release/scripts/validate_source_rat.sh
b/.mvn/wrapper/maven-wrapper.properties
old mode 100755
new mode 100644
similarity index 76%
copy from release/scripts/validate_source_rat.sh
copy to .mvn/wrapper/maven-wrapper.properties
index ad3a29d6..b789cf5b
--- a/release/scripts/validate_source_rat.sh
+++ b/.mvn/wrapper/maven-wrapper.properties
@@ -1,4 +1,3 @@
-#!/bin/bash
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -15,6 +14,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-echo "Running RAT Check"
-(bash -c "mvn apache-rat:check -DdeployArtifacts=true") || (echo -e "\t\t Rat
Check Failed. [ERROR]\n\t\t Please run with --verbose to get details\n" && exit
1)
-echo -e "\t\tRAT Check Passed [OK]\n"
+wrapperVersion=3.3.4
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip
diff --git a/Dockerfile b/Dockerfile
index 9e4a0950..71f8aec6 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -16,14 +16,14 @@
# syntax=docker/dockerfile:1
-FROM maven:3.9.8-eclipse-temurin-11-focal as package
+FROM eclipse-temurin:17-jdk-jammy as package
WORKDIR /build
COPY ./ ./
RUN --mount=type=cache,target=/root/.m2 \
- MAVEN_OPTS=-Dorg.slf4j.simpleLogger.defaultLogLevel=warn mvn -B package
-DskipTests
-RUN mv xtable-utilities/target/xtable-utilities_2.12-$(mvn help:evaluate
-Dexpression=project.version -q -DforceStdout)-bundled.jar target/app.jar
+ MAVEN_OPTS=-Dorg.slf4j.simpleLogger.defaultLogLevel=warn ./mvnw -B -am -pl
xtable-utilities package -DskipTests
+RUN mv xtable-utilities/target/xtable-utilities_2.12-$(./mvnw help:evaluate
-Dexpression=project.version -q -DforceStdout)-bundled.jar target/app.jar
FROM eclipse-temurin:17-jre-jammy AS final
@@ -48,7 +48,7 @@ COPY --from=package build/target/app.jar ./app.jar
ENTRYPOINT [ \
"java", \
"--add-opens=java.base/sun.nio.hb=ALL-UNNAMED", \
- "--add-opens=java.base/sun.nio.ch=ALL-UNNAMED", \
+ "--add-opens=java.base/sun.nio.ch=ALL-UNNAMED", \
"--add-opens=java.base/java.nio=ALL-UNNAMED", \
"--add-opens=java.base/java.lang.invoke=ALL-UNNAMED", \
"--add-opens=java.base/java.util=ALL-UNNAMED", \
diff --git a/README.md b/README.md
index d7ff6447..d35ac856 100644
--- a/README.md
+++ b/README.md
@@ -33,23 +33,23 @@ future.
# Building the project and running tests.
1. Use Java 11 for building the project. If you are using another Java
version, you can use [jenv](https://github.com/jenv/jenv) to use multiple Java
versions locally.
-2. Build the project using `mvn clean package`. Use `mvn clean package
-DskipTests` to skip tests while building.
-3. Use `mvn clean test` or `mvn test` to run all unit tests. If you need to
run only a specific test you can do this
- by something like `mvn test -Dtest=TestDeltaSync -pl xtable-core`.
-4. Similarly, use `mvn clean verify` or `mvn verify` to run integration tests.
+2. Build the project using `./mvnw clean package`. Use `./mvnw clean package
-DskipTests` to skip tests while building.
+3. Use `./mvnw clean test` or `./mvnw test` to run all unit tests. If you need
to run only a specific test you can do this
+ by something like `./mvnw test -Dtest=TestDeltaSync -pl xtable-core`.
+4. Similarly, use `./mvnw clean verify` or `./mvnw verify` to run integration
tests.
**Note:** When using Maven version 3.9 or above, Maven automatically caches
the build. To ignore build caching, you can
-add the `-Dmaven.build.cache.enabled=false` parameter. For example, `mvn clean
package -DskipTests -Dmaven.build.cache.enabled=false`
+add the `-Dmaven.build.cache.enabled=false` parameter. For example, `./mvnw
clean package -DskipTests -Dmaven.build.cache.enabled=false`
# Style guide
1. We use [Maven Spotless
plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) and
[Google java format](https://github.com/google/google-java-format) for code
style.
-2. Use `mvn spotless:check` to find out code style violations and `mvn
spotless:apply` to fix them.
+2. Use `./mvnw spotless:check` to find out code style violations and `./mvnw
spotless:apply` to fix them.
Code style check is tied to compile phase by default, so code style
violations will lead to build failures.
# Running the bundled jar
-1. Get a pre-built bundled jar or create the jar with `mvn install -DskipTests`
+1. Get a pre-built bundled jar or create the jar with `./mvnw install
-DskipTests`
2. Create a yaml file that follows the format below:
```yaml
sourceFormat: HUDI
diff --git a/demo/start_demo.sh b/demo/start_demo.sh
index 3e65d0c8..5a122d83 100755
--- a/demo/start_demo.sh
+++ b/demo/start_demo.sh
@@ -21,7 +21,7 @@ CURRENT_DIR="$( cd "$(dirname "$0")" ; pwd -P )"
XTABLE_HOME="$( cd "$(dirname "$CURRENT_DIR")" ; pwd -P )"
cd $XTABLE_HOME
-mvn install -am -pl xtable-core -DskipTests -T 2
+./mvnw install -am -pl xtable-core -DskipTests -T 2
mkdir -p demo/jars
cp
xtable-hudi-support/xtable-hudi-support-utils/target/xtable-hudi-support-utils-0.2.0-SNAPSHOT.jar
demo/jars
cp xtable-api/target/xtable-api-0.2.0-SNAPSHOT.jar demo/jars
diff --git a/mvnw b/mvnw
new file mode 100755
index 00000000..bd8896bf
--- /dev/null
+++ b/mvnw
@@ -0,0 +1,295 @@
+#!/bin/sh
+# ----------------------------------------------------------------------------
+# 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.
+# ----------------------------------------------------------------------------
+
+# ----------------------------------------------------------------------------
+# Apache Maven Wrapper startup batch script, version 3.3.4
+#
+# Optional ENV vars
+# -----------------
+# JAVA_HOME - location of a JDK home dir, required when download maven via
java source
+# MVNW_REPOURL - repo url base for downloading maven distribution
+# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven
+# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script;
others: silence the output
+# ----------------------------------------------------------------------------
+
+set -euf
+[ "${MVNW_VERBOSE-}" != debug ] || set -x
+
+# OS specific support.
+native_path() { printf %s\\n "$1"; }
+case "$(uname)" in
+CYGWIN* | MINGW*)
+ [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")"
+ native_path() { cygpath --path --windows "$1"; }
+ ;;
+esac
+
+# set JAVACMD and JAVACCMD
+set_java_home() {
+ # For Cygwin and MinGW, ensure paths are in Unix format before anything is
touched
+ if [ -n "${JAVA_HOME-}" ]; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ]; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD="$JAVA_HOME/jre/sh/java"
+ JAVACCMD="$JAVA_HOME/jre/sh/javac"
+ else
+ JAVACMD="$JAVA_HOME/bin/java"
+ JAVACCMD="$JAVA_HOME/bin/javac"
+
+ if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then
+ echo "The JAVA_HOME environment variable is not defined correctly, so
mvnw cannot run." >&2
+ echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\"
or \"\$JAVA_HOME/bin/javac\" does not exist." >&2
+ return 1
+ fi
+ fi
+ else
+ JAVACMD="$(
+ 'set' +e
+ 'unset' -f command 2>/dev/null
+ 'command' -v java
+ )" || :
+ JAVACCMD="$(
+ 'set' +e
+ 'unset' -f command 2>/dev/null
+ 'command' -v javac
+ )" || :
+
+ if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then
+ echo "The java/javac command does not exist in PATH nor is JAVA_HOME
set, so mvnw cannot run." >&2
+ return 1
+ fi
+ fi
+}
+
+# hash string like Java String::hashCode
+hash_string() {
+ str="${1:-}" h=0
+ while [ -n "$str" ]; do
+ char="${str%"${str#?}"}"
+ h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296))
+ str="${str#?}"
+ done
+ printf %x\\n $h
+}
+
+verbose() { :; }
+[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; }
+
+die() {
+ printf %s\\n "$1" >&2
+ exit 1
+}
+
+trim() {
+ # MWRAPPER-139:
+ # Trims trailing and leading whitespace, carriage returns, tabs, and
linefeeds.
+ # Needed for removing poorly interpreted newline sequences when running in
more
+ # exotic environments such as mingw bash on Windows.
+ printf "%s" "${1}" | tr -d '[:space:]'
+}
+
+scriptDir="$(dirname "$0")"
+scriptName="$(basename "$0")"
+
+# parse distributionUrl and optional distributionSha256Sum, requires
.mvn/wrapper/maven-wrapper.properties
+while IFS="=" read -r key value; do
+ case "${key-}" in
+ distributionUrl) distributionUrl=$(trim "${value-}") ;;
+ distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;;
+ esac
+done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties"
+[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in
$scriptDir/.mvn/wrapper/maven-wrapper.properties"
+
+case "${distributionUrl##*/}" in
+maven-mvnd-*bin.*)
+ MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/
+ case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in
+ *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;;
+ :Darwin*x86_64) distributionPlatform=darwin-amd64 ;;
+ :Darwin*arm64) distributionPlatform=darwin-aarch64 ;;
+ :Linux*x86_64*) distributionPlatform=linux-amd64 ;;
+ *)
+ echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use
pure java version" >&2
+ distributionPlatform=linux-amd64
+ ;;
+ esac
+ distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip"
+ ;;
+maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;;
+*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;;
+esac
+
+# apply MVNW_REPOURL and calculate MAVEN_HOME
+# maven home pattern:
~/.m2/wrapper/dists/{apache-maven-<version>,maven-mvnd-<version>-<platform>}/<hash>
+[ -z "${MVNW_REPOURL-}" ] ||
distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}"
+distributionUrlName="${distributionUrl##*/}"
+distributionUrlNameMain="${distributionUrlName%.*}"
+distributionUrlNameMain="${distributionUrlNameMain%-bin}"
+MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}"
+MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string
"$distributionUrl")"
+
+exec_maven() {
+ unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || :
+ exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec
$MAVEN_HOME/bin/$MVN_CMD"
+}
+
+if [ -d "$MAVEN_HOME" ]; then
+ verbose "found existing MAVEN_HOME at $MAVEN_HOME"
+ exec_maven "$@"
+fi
+
+case "${distributionUrl-}" in
+*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;;
+*) die "distributionUrl is not valid, must match *-bin.zip or
maven-mvnd-*.zip, but found '${distributionUrl-}'" ;;
+esac
+
+# prepare tmp dir
+if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then
+ clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; }
+ trap clean HUP INT TERM EXIT
+else
+ die "cannot create temp dir"
+fi
+
+mkdir -p -- "${MAVEN_HOME%/*}"
+
+# Download and Install Apache Maven
+verbose "Couldn't find MAVEN_HOME, downloading and installing it ..."
+verbose "Downloading from: $distributionUrl"
+verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName"
+
+# select .zip or .tar.gz
+if ! command -v unzip >/dev/null; then
+ distributionUrl="${distributionUrl%.zip}.tar.gz"
+ distributionUrlName="${distributionUrl##*/}"
+fi
+
+# verbose opt
+__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q
__MVNW_QUIET_TAR=''
+[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL=''
__MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v
+
+# normalize http auth
+case "${MVNW_PASSWORD:+has-password}" in
+'') MVNW_USERNAME='' MVNW_PASSWORD='' ;;
+has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD=''
;;
+esac
+
+if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then
+ verbose "Found wget ... using wget"
+ wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O
"$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch
$distributionUrl"
+elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then
+ verbose "Found curl ... using curl"
+ curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o
"$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl:
Failed to fetch $distributionUrl"
+elif set_java_home; then
+ verbose "Falling back to use Java to download"
+ javaSource="$TMP_DOWNLOAD_DIR/Downloader.java"
+ targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName"
+ cat >"$javaSource" <<-END
+ public class Downloader extends java.net.Authenticator
+ {
+ protected java.net.PasswordAuthentication getPasswordAuthentication()
+ {
+ return new java.net.PasswordAuthentication( System.getenv(
"MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() );
+ }
+ public static void main( String[] args ) throws Exception
+ {
+ setDefault( new Downloader() );
+ java.nio.file.Files.copy( java.net.URI.create( args[0]
).toURL().openStream(), java.nio.file.Paths.get( args[1]
).toAbsolutePath().normalize() );
+ }
+ }
+ END
+ # For Cygwin/MinGW, switch paths to Windows format before running javac and
java
+ verbose " - Compiling Downloader.java ..."
+ "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed
to compile Downloader.java"
+ verbose " - Running Downloader.java ..."
+ "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")"
Downloader "$distributionUrl" "$(native_path "$targetZip")"
+fi
+
+# If specified, validate the SHA-256 sum of the Maven distribution zip file
+if [ -n "${distributionSha256Sum-}" ]; then
+ distributionSha256Result=false
+ if [ "$MVN_CMD" = mvnd.sh ]; then
+ echo "Checksum validation is not supported for maven-mvnd." >&2
+ echo "Please disable validation by removing 'distributionSha256Sum' from
your maven-wrapper.properties." >&2
+ exit 1
+ elif command -v sha256sum >/dev/null; then
+ if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" |
sha256sum -c - >/dev/null 2>&1; then
+ distributionSha256Result=true
+ fi
+ elif command -v shasum >/dev/null; then
+ if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" |
shasum -a 256 -c >/dev/null 2>&1; then
+ distributionSha256Result=true
+ fi
+ else
+ echo "Checksum validation was requested but neither 'sha256sum' or
'shasum' are available." >&2
+ echo "Please install either command, or disable validation by removing
'distributionSha256Sum' from your maven-wrapper.properties." >&2
+ exit 1
+ fi
+ if [ $distributionSha256Result = false ]; then
+ echo "Error: Failed to validate Maven distribution SHA-256, your Maven
distribution might be compromised." >&2
+ echo "If you updated your Maven version, you need to update the specified
distributionSha256Sum property." >&2
+ exit 1
+ fi
+fi
+
+# unzip and move
+if command -v unzip >/dev/null; then
+ unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"}
"$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed
to unzip"
+else
+ tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"}
"$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed
to untar"
+fi
+
+# Find the actual extracted directory name (handles snapshots where filename
!= directory name)
+actualDistributionDir=""
+
+# First try the expected directory name (for regular distributions)
+if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then
+ if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then
+ actualDistributionDir="$distributionUrlNameMain"
+ fi
+fi
+
+# If not found, search for any directory with the Maven executable (for
snapshots)
+if [ -z "$actualDistributionDir" ]; then
+ # enable globbing to iterate over items
+ set +f
+ for dir in "$TMP_DOWNLOAD_DIR"/*; do
+ if [ -d "$dir" ]; then
+ if [ -f "$dir/bin/$MVN_CMD" ]; then
+ actualDistributionDir="$(basename "$dir")"
+ break
+ fi
+ fi
+ done
+ set -f
+fi
+
+if [ -z "$actualDistributionDir" ]; then
+ verbose "Contents of $TMP_DOWNLOAD_DIR:"
+ verbose "$(ls -la "$TMP_DOWNLOAD_DIR")"
+ die "Could not find Maven distribution directory in extracted archive"
+fi
+
+verbose "Found extracted Maven distribution directory: $actualDistributionDir"
+printf %s\\n "$distributionUrl"
>"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url"
+mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d
"$MAVEN_HOME" ] || die "fail to move MAVEN_HOME"
+
+clean || :
+exec_maven "$@"
diff --git a/mvnw.cmd b/mvnw.cmd
new file mode 100644
index 00000000..5761d948
--- /dev/null
+++ b/mvnw.cmd
@@ -0,0 +1,189 @@
+<# : batch portion
+@REM
----------------------------------------------------------------------------
+@REM Licensed to the Apache Software Foundation (ASF) under one
+@REM or more contributor license agreements. See the NOTICE file
+@REM distributed with this work for additional information
+@REM regarding copyright ownership. The ASF licenses this file
+@REM to you under the Apache License, Version 2.0 (the
+@REM "License"); you may not use this file except in compliance
+@REM with the License. You may obtain a copy of the License at
+@REM
+@REM http://www.apache.org/licenses/LICENSE-2.0
+@REM
+@REM Unless required by applicable law or agreed to in writing,
+@REM software distributed under the License is distributed on an
+@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+@REM KIND, either express or implied. See the License for the
+@REM specific language governing permissions and limitations
+@REM under the License.
+@REM
----------------------------------------------------------------------------
+
+@REM
----------------------------------------------------------------------------
+@REM Apache Maven Wrapper startup batch script, version 3.3.4
+@REM
+@REM Optional ENV vars
+@REM MVNW_REPOURL - repo url base for downloading maven distribution
+@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven
+@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output
+@REM
----------------------------------------------------------------------------
+
+@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0)
+@SET __MVNW_CMD__=
+@SET __MVNW_ERROR__=
+@SET __MVNW_PSMODULEP_SAVE=%PSModulePath%
+@SET PSModulePath=
+@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "&
{$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock
([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @(
+ IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE
(echo %%A=%%B)
+)
+@SET PSModulePath=%__MVNW_PSMODULEP_SAVE%
+@SET __MVNW_PSMODULEP_SAVE=
+@SET __MVNW_ARG0_NAME__=
+@SET MVNW_USERNAME=
+@SET MVNW_PASSWORD=
+@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*)
+@echo Cannot start maven from wrapper >&2 && exit /b 1
+@GOTO :EOF
+: end batch / begin powershell #>
+
+$ErrorActionPreference = "Stop"
+if ($env:MVNW_VERBOSE -eq "true") {
+ $VerbosePreference = "Continue"
+}
+
+# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties
+$distributionUrl = (Get-Content -Raw
"$scriptDir/.mvn/wrapper/maven-wrapper.properties" |
ConvertFrom-StringData).distributionUrl
+if (!$distributionUrl) {
+ Write-Error "cannot read distributionUrl property in
$scriptDir/.mvn/wrapper/maven-wrapper.properties"
+}
+
+switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) {
+ "maven-mvnd-*" {
+ $USE_MVND = $true
+ $distributionUrl = $distributionUrl -replace
'-bin\.[^.]*$',"-windows-amd64.zip"
+ $MVN_CMD = "mvnd.cmd"
+ break
+ }
+ default {
+ $USE_MVND = $false
+ $MVN_CMD = $script -replace '^mvnw','mvn'
+ break
+ }
+}
+
+# apply MVNW_REPOURL and calculate MAVEN_HOME
+# maven home pattern:
~/.m2/wrapper/dists/{apache-maven-<version>,maven-mvnd-<version>-<platform>}/<hash>
+if ($env:MVNW_REPOURL) {
+ $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else
{ "/maven/mvnd/" }
+ $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl
-replace "^.*$MVNW_REPO_PATTERN",'')"
+}
+$distributionUrlName = $distributionUrl -replace '^.*/',''
+$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$',''
-replace '-bin$',''
+
+$MAVEN_M2_PATH = "$HOME/.m2"
+if ($env:MAVEN_USER_HOME) {
+ $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME"
+}
+
+if (-not (Test-Path -Path $MAVEN_M2_PATH)) {
+ New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null
+}
+
+$MAVEN_WRAPPER_DISTS = $null
+if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) {
+ $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists"
+} else {
+ $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists"
+}
+
+$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain"
+$MAVEN_HOME_NAME =
([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl)
| ForEach-Object {$_.ToString("x2")}) -join ''
+$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME"
+
+if (Test-Path -Path "$MAVEN_HOME" -PathType Container) {
+ Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME"
+ Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD"
+ exit $?
+}
+
+if (! $distributionUrlNameMain -or ($distributionUrlName -eq
$distributionUrlNameMain)) {
+ Write-Error "distributionUrl is not valid, must end with *-bin.zip, but
found $distributionUrl"
+}
+
+# prepare tmp dir
+$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile
+$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path
"$TMP_DOWNLOAD_DIR_HOLDER.dir"
+$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null
+trap {
+ if ($TMP_DOWNLOAD_DIR.Exists) {
+ try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null }
+ catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" }
+ }
+}
+
+New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null
+
+# Download and Install Apache Maven
+Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..."
+Write-Verbose "Downloading from: $distributionUrl"
+Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName"
+
+$webclient = New-Object System.Net.WebClient
+if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) {
+ $webclient.Credentials = New-Object
System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD)
+}
+[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+$webclient.DownloadFile($distributionUrl,
"$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null
+
+# If specified, validate the SHA-256 sum of the Maven distribution zip file
+$distributionSha256Sum = (Get-Content -Raw
"$scriptDir/.mvn/wrapper/maven-wrapper.properties" |
ConvertFrom-StringData).distributionSha256Sum
+if ($distributionSha256Sum) {
+ if ($USE_MVND) {
+ Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease
disable validation by removing 'distributionSha256Sum' from your
maven-wrapper.properties."
+ }
+ Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function
Get-FileHash
+ if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm
SHA256).Hash.ToLower() -ne $distributionSha256Sum) {
+ Write-Error "Error: Failed to validate Maven distribution SHA-256, your
Maven distribution might be compromised. If you updated your Maven version, you
need to update the specified distributionSha256Sum property."
+ }
+}
+
+# unzip and move
+Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath
"$TMP_DOWNLOAD_DIR" | Out-Null
+
+# Find the actual extracted directory name (handles snapshots where filename
!= directory name)
+$actualDistributionDir = ""
+
+# First try the expected directory name (for regular distributions)
+$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain"
+$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD"
+if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path
$expectedMvnPath -PathType Leaf)) {
+ $actualDistributionDir = $distributionUrlNameMain
+}
+
+# If not found, search for any directory with the Maven executable (for
snapshots)
+if (!$actualDistributionDir) {
+ Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object {
+ $testPath = Join-Path $_.FullName "bin/$MVN_CMD"
+ if (Test-Path -Path $testPath -PathType Leaf) {
+ $actualDistributionDir = $_.Name
+ }
+ }
+}
+
+if (!$actualDistributionDir) {
+ Write-Error "Could not find Maven distribution directory in extracted
archive"
+}
+
+Write-Verbose "Found extracted Maven distribution directory:
$actualDistributionDir"
+Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName
$MAVEN_HOME_NAME | Out-Null
+try {
+ Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination
$MAVEN_HOME_PARENT | Out-Null
+} catch {
+ if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) {
+ Write-Error "fail to move MAVEN_HOME"
+ }
+} finally {
+ try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null }
+ catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" }
+}
+
+Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD"
diff --git a/release/release_guide.md b/release/release_guide.md
index 2a69cafc..9ad8986a 100644
--- a/release/release_guide.md
+++ b/release/release_guide.md
@@ -156,10 +156,10 @@ Usage
## Verify that a Release Build Works
-Run "mvn -Prelease clean install" to ensure that the build processes are in
good shape. // You need to execute this command once you have the release
branch in apache/incubator-xtable
+Run "./mvnw -Prelease clean install" to ensure that the build processes are in
good shape. // You need to execute this command once you have the release
branch in apache/incubator-xtable
```shell
-mvn -Prelease clean install
+./mvnw -Prelease clean install
```
# Build a release candidate
@@ -189,7 +189,7 @@ Set up a few environment variables to simplify Maven
commands that follow. This
4. tar -zxvf apache-xtable-${RELEASE_VERSION}.src.tgz
5. diff -qr apache-xtable-${RELEASE_VERSION} incubator-xtable-tmp-clone
6. Ensure the diff contains assets,demo,website,xtable-utilities and
non-binary files only in incubator-xtable-tmp-clone.
- 7. cd apache-xtable-${RELEASE_VERSION} && mvn clean package -DskipTests
+ 7. cd apache-xtable-${RELEASE_VERSION} && ./mvnw clean package
-DskipTests
8. If they pass, delete the repository we got from the tar-ball
- cd ../ && rm -rf apache-xtable-${RELEASE_VERSION} && rm -rf
incubator-xtable-tmp-clone
@@ -238,7 +238,7 @@ Set up a few environment variables to simplify Maven
commands that follow. This
1. This will deploy jar artifacts to the Apache Nexus Repository, which is
the staging area for deploying jars to Maven Central.
2. Review all staged artifacts (https://repository.apache.org/). They
should contain all relevant parts for each module, including pom.xml, jar, test
jar, source, test source, javadoc, etc. Carefully review any new artifacts.
3. git checkout ${RELEASE_BRANCH} && export GPG_TTY=$(tty)
- 4. mvn deploy -Prelease -DskipTests -DdeployArtifacts=true
+ 4. ./mvnw deploy -Prelease -DskipTests -DdeployArtifacts=true
1. when prompted for the passphrase, if you have multiple gpg keys in
your keyring, make sure that you enter the right passphase corresponding to the
same key (FINGERPRINT) as used while generating source release in step f.ii.
> If the prompt is not for the same key (by default the
maven-gpg-plugin will pick up the first key in your keyring so that could be
different), then add the following option to your ~/.gnupg/gpg.conf file
2. make sure your IP is not changing while uploading, otherwise it
creates a different staging repo
diff --git a/release/scripts/cut_release_branch.sh
b/release/scripts/cut_release_branch.sh
index c26bfcda..3432253c 100755
--- a/release/scripts/cut_release_branch.sh
+++ b/release/scripts/cut_release_branch.sh
@@ -93,7 +93,7 @@ echo ${NEXT_VERSION_BRANCH}
echo "==============================================================="
# Update main branch
-mvn versions:set -DnewVersion=${NEXT_VERSION_IN_BASE_BRANCH}-SNAPSHOT
+./mvnw versions:set -DnewVersion=${NEXT_VERSION_IN_BASE_BRANCH}-SNAPSHOT
echo "===========Update next-version branch as following============="
git diff
@@ -116,7 +116,7 @@ read confirmation
# Checkout and update release branch
git checkout ${RELEASE_BRANCH}
-mvn versions:set -DnewVersion=${RELEASE}
+./mvnw versions:set -DnewVersion=${RELEASE}
echo "==================Current working branch======================="
echo ${RELEASE_BRANCH}
diff --git a/release/scripts/deploy_staging_jars.sh
b/release/scripts/deploy_staging_jars.sh
index fb20c47c..9d4b65f8 100644
--- a/release/scripts/deploy_staging_jars.sh
+++ b/release/scripts/deploy_staging_jars.sh
@@ -17,7 +17,7 @@
#
## Variables with defaults (if not overwritten by environment)
##
-MVN=${MVN:-mvn}
+MVN=${MVN:-./mvnw}
# fail immediately
set -o errexit
set -o nounset
diff --git a/release/scripts/validate_source_rat.sh
b/release/scripts/validate_source_rat.sh
index ad3a29d6..38dd62b7 100755
--- a/release/scripts/validate_source_rat.sh
+++ b/release/scripts/validate_source_rat.sh
@@ -16,5 +16,5 @@
# limitations under the License.
#
echo "Running RAT Check"
-(bash -c "mvn apache-rat:check -DdeployArtifacts=true") || (echo -e "\t\t Rat
Check Failed. [ERROR]\n\t\t Please run with --verbose to get details\n" && exit
1)
+(bash -c "./mvnw apache-rat:check -DdeployArtifacts=true") || (echo -e "\t\t
Rat Check Failed. [ERROR]\n\t\t Please run with --verbose to get details\n" &&
exit 1)
echo -e "\t\tRAT Check Passed [OK]\n"
diff --git a/website/docs/setup.md b/website/docs/setup.md
index e414d44b..d7b38da6 100644
--- a/website/docs/setup.md
+++ b/website/docs/setup.md
@@ -11,12 +11,12 @@ This page covers the essential steps to setup Apache
XTable™ (incubating) in y
Once the project is successfully cloned in your environment, you can build the
jars from the source using the below command.
```shell md title=="shell"
-mvn clean package
+./mvnw clean package
```
For skipping the tests while building, add `-DskipTests`.
```shell md title=="shell"
-mvn clean package -DskipTests
+./mvnw clean package -DskipTests
```
For more information on the steps, follow the project's GitHub
[README.md](https://github.com/apache/incubator-xtable/blob/main/README.md)
diff --git a/xtable-service/README.md b/xtable-service/README.md
index 00a0b119..9b4db827 100644
--- a/xtable-service/README.md
+++ b/xtable-service/README.md
@@ -28,13 +28,13 @@ See XTable's `spec` module for more details:
https://github.com/apache/incubator
To run the service locally, first ensure you have built the project with
```sh
-mvn clean install -DskipTests
+./mvnw clean install -DskipTests
```
Then you can run start the quarkus service using the following command:
```sh
-mvn quarkus:dev -pl xtable-service
+./mvnw quarkus:dev -pl xtable-service
```
This will start the service on `http://localhost:8080`.
