From d83580cd7323f60922036349489ada627cb509d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 14:58:53 +0200 Subject: [PATCH 1/9] example project added --- .gitattributes | 3 + example/.gitattributes | 3 + example/.gitignore | 11 + example/.mvn/extensions.xml | 10 + .../.mvn/maven-git-versioning-extension.xml | 25 ++ example/.mvn/wrapper/maven-wrapper.properties | 19 ++ example/mvnw | 259 ++++++++++++++++++ example/mvnw.cmd | 149 ++++++++++ example/pom.xml | 55 ++++ 9 files changed, 534 insertions(+) create mode 100644 .gitattributes create mode 100644 example/.gitattributes create mode 100644 example/.gitignore create mode 100644 example/.mvn/extensions.xml create mode 100644 example/.mvn/maven-git-versioning-extension.xml create mode 100644 example/.mvn/wrapper/maven-wrapper.properties create mode 100755 example/mvnw create mode 100644 example/mvnw.cmd create mode 100644 example/pom.xml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..871fae54 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +* text=auto +mvnw text eol=lf +mvnw.cmd text eol=crlf \ No newline at end of file diff --git a/example/.gitattributes b/example/.gitattributes new file mode 100644 index 00000000..871fae54 --- /dev/null +++ b/example/.gitattributes @@ -0,0 +1,3 @@ +* text=auto +mvnw text eol=lf +mvnw.cmd text eol=crlf \ No newline at end of file diff --git a/example/.gitignore b/example/.gitignore new file mode 100644 index 00000000..cd35a822 --- /dev/null +++ b/example/.gitignore @@ -0,0 +1,11 @@ +.settings/ +target/ +.classpath +.project +.checkstyle +.idea/ +*.iml +.m2/ +.*-pom.xml + +pom.xml.versionsBackup diff --git a/example/.mvn/extensions.xml b/example/.mvn/extensions.xml new file mode 100644 index 00000000..f2f00ed0 --- /dev/null +++ b/example/.mvn/extensions.xml @@ -0,0 +1,10 @@ + + + + me.qoomon + maven-git-versioning-extension + 9.6.6 + + + diff --git a/example/.mvn/maven-git-versioning-extension.xml b/example/.mvn/maven-git-versioning-extension.xml new file mode 100644 index 00000000..56794333 --- /dev/null +++ b/example/.mvn/maven-git-versioning-extension.xml @@ -0,0 +1,25 @@ + + + + + .+ + ${ref}-SNAPSHOT + + ${ref} + + + + + .*)]]> + ${ref.version} + + + + + + ${commit} + + + \ No newline at end of file diff --git a/example/.mvn/wrapper/maven-wrapper.properties b/example/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..93a0d797 --- /dev/null +++ b/example/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,19 @@ +# 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. +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.4/apache-maven-3.9.4-bin.zip diff --git a/example/mvnw b/example/mvnw new file mode 100755 index 00000000..19529ddf --- /dev/null +++ b/example/mvnw @@ -0,0 +1,259 @@ +#!/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.2 +# +# 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:]' +} + +# 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 <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.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${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -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 +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/example/mvnw.cmd b/example/mvnw.cmd new file mode 100644 index 00000000..249bdf38 --- /dev/null +++ b/example/mvnw.cmd @@ -0,0 +1,149 @@ +<# : 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.2 +@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-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND) { "/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_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::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 +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -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/example/pom.xml b/example/pom.xml new file mode 100644 index 00000000..89c42d4e --- /dev/null +++ b/example/pom.xml @@ -0,0 +1,55 @@ + + 4.0.0 + + me.qoomon + maven-git-versioning-extension-example + automatic-versioned-by-maven-git-versioning-extension + + Maven Git Versioning Extension Example + Maven Git Versioning Extension Example Project + https://github.com/qoomon/maven-git-versioning-extension/example + + + https://github.com/qoomon/maven-git-versioning-extension.git + scm:git:https://github.com/qoomon/maven-git-versioning-extension.git + + + + + The MIT License (MIT) + https://opensource.org/licenses/MIT + repo + + + + + UTF-8 + UTF-8 + 11 + 11 + + + + + + org.apache.maven.plugins + maven-help-plugin + 3.4.1 + + + write-version-to-file + validate + + evaluate + + + project.version + ${project.basedir}/target/project.version + + + + + + + From b1d62473de3af8ee1f82d7a3947221847601f086 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 15:46:32 +0200 Subject: [PATCH 2/9] documentation improved --- README.md | 10 +++++-- .../.mvn/maven-git-versioning-extension.xml | 10 +++---- example/README.md | 30 +++++++++++++++++++ example/pom.xml | 1 + example/src/main/java/.gitkeep | 0 5 files changed, 42 insertions(+), 9 deletions(-) create mode 100644 example/README.md create mode 100644 example/src/main/java/.gitkeep diff --git a/README.md b/README.md index 671b15a6..0db72d7c 100644 --- a/README.md +++ b/README.md @@ -195,7 +195,6 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY` ```
- - `${ref}` `${ref.slug}` ref name (branch or tag name or commit hash) - Ref Pattern Groups - Content of regex groups in `` can be addressed like this: @@ -208,8 +207,13 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY` ${ref.feature}-SNAPSHOT ``` -
- + - Limiting the length (max. 63 chars): + ```xml + + .{53}).*]]> + ${ref.branchName}-SNAPSHOT + + ``` - `${commit}` commit hash '0fc20459a8eceb2c4abb9bf0af45a6e8af17b94b' - `${commit.short}` commit hash (7 characters) e.g. '0fc2045' - `${commit.timestamp}` commit timestamp (epoch seconds) e.g. '1560694278' diff --git a/example/.mvn/maven-git-versioning-extension.xml b/example/.mvn/maven-git-versioning-extension.xml index 56794333..6bb13c2c 100644 --- a/example/.mvn/maven-git-versioning-extension.xml +++ b/example/.mvn/maven-git-versioning-extension.xml @@ -4,11 +4,10 @@ - .+ - ${ref}-SNAPSHOT - - ${ref} - + + + .{53}).*]]> + ${ref.branchName}-SNAPSHOT @@ -21,5 +20,4 @@ ${commit} - \ No newline at end of file diff --git a/example/README.md b/example/README.md new file mode 100644 index 00000000..8cce9c1c --- /dev/null +++ b/example/README.md @@ -0,0 +1,30 @@ +# maven-git-version-extension example project + +This project demonstrates the extension setup in a maven project. + +## Extension Configuration + +* maven extension configuration: [.mvn/extensions.xml](.mvn/extensions.xml) +* maven-git-versioning-extension configuration: [.mvn/maven-git-versioning-extension.xml](.mvn/maven-git-versioning-extension.xml) + +Version Setup: + +* branches: <branchName>-SNAPSHOT +* tags: vX.Y.Z -> X.Y.Z + +## Writing the version to a file + +* for usage in other tools +* using the maven help plugin, see [pom.xml](pom.xml#L41) +* writing the file to: target/project.version +* Example usage as docker tag: + + $ PROJECT_VERSION=$(cat target/project.version) + $ docker build -t my-docker-image:${PROJECT_VERSION} . + +## Limiting the version length + +* branch names could be very long, so the generated will be too +* but for example [k8s label names](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) are limited to 63 characters +* we use the [pattern regex](.mvn/maven-git-versioning-extension.xml#L8) to cut down the version to this limit +* the version will still end with -SNAPSHOT, but the branch name will be cut down to 53 characters diff --git a/example/pom.xml b/example/pom.xml index 89c42d4e..fc1a8b4b 100644 --- a/example/pom.xml +++ b/example/pom.xml @@ -38,6 +38,7 @@ 3.4.1 + write-version-to-file validate diff --git a/example/src/main/java/.gitkeep b/example/src/main/java/.gitkeep new file mode 100644 index 00000000..e69de29b From d58c5e900fd0e4cd5e5a2ed02c2c3768740b393c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 15:50:50 +0200 Subject: [PATCH 3/9] review cleanup --- example/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/README.md b/example/README.md index 8cce9c1c..3d88b59c 100644 --- a/example/README.md +++ b/example/README.md @@ -26,5 +26,5 @@ Version Setup: * branch names could be very long, so the generated will be too * but for example [k8s label names](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) are limited to 63 characters -* we use the [pattern regex](.mvn/maven-git-versioning-extension.xml#L8) to cut down the version to this limit +* we use the [pattern regex](.mvn/maven-git-versioning-extension.xml#L9) to cut down the version to this limit * the version will still end with -SNAPSHOT, but the branch name will be cut down to 53 characters From 8dec785a8f820e1dda6e94858d9bb11467d50bc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 15:57:29 +0200 Subject: [PATCH 4/9] review cleanup --- example/.mvn/extensions.xml | 2 +- example/.mvn/maven-git-versioning-extension.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/example/.mvn/extensions.xml b/example/.mvn/extensions.xml index f2f00ed0..664f5033 100644 --- a/example/.mvn/extensions.xml +++ b/example/.mvn/extensions.xml @@ -4,7 +4,7 @@ me.qoomon maven-git-versioning-extension - 9.6.6 + 9.8.0 diff --git a/example/.mvn/maven-git-versioning-extension.xml b/example/.mvn/maven-git-versioning-extension.xml index 6bb13c2c..ca2f60c1 100644 --- a/example/.mvn/maven-git-versioning-extension.xml +++ b/example/.mvn/maven-git-versioning-extension.xml @@ -20,4 +20,4 @@ ${commit} - \ No newline at end of file + From 1c34fb782b2a8b772c219b5cd514a7f723f7f0f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 16:04:56 +0200 Subject: [PATCH 5/9] fix short branch names --- example/.mvn/maven-git-versioning-extension.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/.mvn/maven-git-versioning-extension.xml b/example/.mvn/maven-git-versioning-extension.xml index ca2f60c1..11c6db4e 100644 --- a/example/.mvn/maven-git-versioning-extension.xml +++ b/example/.mvn/maven-git-versioning-extension.xml @@ -6,7 +6,7 @@ - .{53}).*]]> + .+{53}).*]]> ${ref.branchName}-SNAPSHOT From 0994f77fddf6bcef3d2a72b158fb286180ae044c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 16:13:20 +0200 Subject: [PATCH 6/9] regex fixed for shorter branch names --- README.md | 2 +- example/.mvn/maven-git-versioning-extension.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0db72d7c..c49de202 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY` - Limiting the length (max. 63 chars): ```xml - .{53}).*]]> + .{1,53}).*]]> ${ref.branchName}-SNAPSHOT ``` diff --git a/example/.mvn/maven-git-versioning-extension.xml b/example/.mvn/maven-git-versioning-extension.xml index 11c6db4e..5266c3b6 100644 --- a/example/.mvn/maven-git-versioning-extension.xml +++ b/example/.mvn/maven-git-versioning-extension.xml @@ -6,7 +6,7 @@ - .+{53}).*]]> + .{1,53}).*]]> ${ref.branchName}-SNAPSHOT From 00442ff296947b8e813495811b6180cbd4a25056 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 16:19:50 +0200 Subject: [PATCH 7/9] review cleanup --- example/.gitattributes | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/example/.gitattributes b/example/.gitattributes index 871fae54..d9539dc2 100644 --- a/example/.gitattributes +++ b/example/.gitattributes @@ -1,3 +1,3 @@ * text=auto mvnw text eol=lf -mvnw.cmd text eol=crlf \ No newline at end of file +mvnw.cmd text eol=crlf From 092ef24c330492090352bc347dc53387f70a9c13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 16:20:40 +0200 Subject: [PATCH 8/9] review cleanup --- .gitattributes | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitattributes b/.gitattributes index 871fae54..d9539dc2 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,3 @@ * text=auto mvnw text eol=lf -mvnw.cmd text eol=crlf \ No newline at end of file +mvnw.cmd text eol=crlf From 028e83d36569ba1fee6d3b62553ca6a51ffd5142 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Mei=C3=9F?= Date: Fri, 7 Jun 2024 16:21:42 +0200 Subject: [PATCH 9/9] review cleanup --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c49de202..41ec8bb9 100644 --- a/README.md +++ b/README.md @@ -195,6 +195,7 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY` ```
+ - `${ref}` `${ref.slug}` ref name (branch or tag name or commit hash) - Ref Pattern Groups - Content of regex groups in `` can be addressed like this: @@ -207,6 +208,7 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY` ${ref.feature}-SNAPSHOT ``` +
- Limiting the length (max. 63 chars): ```xml @@ -214,6 +216,7 @@ e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY` ${ref.branchName}-SNAPSHOT ``` +
- `${commit}` commit hash '0fc20459a8eceb2c4abb9bf0af45a6e8af17b94b' - `${commit.short}` commit hash (7 characters) e.g. '0fc2045' - `${commit.timestamp}` commit timestamp (epoch seconds) e.g. '1560694278'