diff --git a/.github/workflows/convention-develocity-gradle-plugin-verification.yml b/.github/workflows/convention-develocity-gradle-plugin-verification.yml index 7279871941..7c9d8fcb73 100644 --- a/.github/workflows/convention-develocity-gradle-plugin-verification.yml +++ b/.github/workflows/convention-develocity-gradle-plugin-verification.yml @@ -45,13 +45,15 @@ jobs: versions: - sample: '5' version: '5.0' - - sample: '6_and_later' + - sample: '6' version: '6.0.1' - - sample: '6_and_later' + - sample: '6.9_and_later' + version: '6.9.4' + - sample: '6.9_and_later' version: '7.0.2' - - sample: '6_and_later' + - sample: '6.9_and_later' version: '8.0.2' - - sample: '6_and_later' + - sample: '6.9_and_later' version: '(Current)' steps: - name: Checkout diff --git a/convention-develocity-gradle-plugin/README.md b/convention-develocity-gradle-plugin/README.md index 8f1ef287c4..cd5aa9ad21 100644 --- a/convention-develocity-gradle-plugin/README.md +++ b/convention-develocity-gradle-plugin/README.md @@ -1,8 +1,39 @@ ## Convention Develocity Gradle Plugin -This project demonstrates how a convention plugin can share the same Develocity build configuration across multiple projects. It -is intended to serve as a starting point for creating your own Gradle plugin that applies your specific Develocity configuration. Note -the inline comments in the build and source code for things to adjust specifically to your needs. +This project demonstrates how a convention plugin can share the same Develocity build configuration across multiple projects. +It is intended to serve as a starting point for creating your own Gradle plugin that applies your specific Develocity configuration. +Note the inline comments in the build and source code for things to adjust specifically to your needs. + +### Applying the plugin to your build + +#### Using a dynamic version + +For builds using Gradle 6.9 and later, it's recommended to apply the convention plugin using a [dynamic version](https://docs.gradle.org/current/userguide/dynamic_versions.html). +This approach ensures that the latest version of the plugin is resolved, up to the specified maximum version. +For example, the following resolves the latest version of the plugin up to, but excluding, version `2.0.0`: + +```groovy +plugins { + id 'com.myorg.convention-develocity-gradle-5-or-newer' version '(,2.0.0)' +} +``` + +This allows you to quickly roll out non-breaking changes to all consumers of the convention plugin. +Breaking changes in the plugin should be released under a new major version (e.g., `2.0.0`). +All consumers of the plugin will then need to update the upper boundary of the dynamic version to the next major version (e.g., `(,3.0.0)`). + +#### Using a static version + +For projects using earlier versions of Gradle, the convention plugin must be applied using a static version. +For example: + +```groovy +plugins { + id 'com.myorg.convention-develocity-gradle-5-or-newer' version '1.0.0' +} +``` + +For each new release of the convention plugin, builds will need to be manually updated. ### Content @@ -15,7 +46,8 @@ This project is structured as follows: * `gradle_3_and_earlier` - Applies the convention plugin on a Gradle 3 and earlier (only the Develocity plugin is applied) * `gradle_4` - Applies the convention plugin on a Gradle 4 build (the Develocity and CCUD plugins are applied) * `gradle_5` - Applies the convention plugin on a Gradle 5 build (the Develocity and CCUD plugins are applied) - * `gradle_6_and_later` - Applies the convention plugin on a Gradle 6 and later build (the Develocity and CCUD plugins are applied) + * `gradle_6` - Applies the convention plugin on a Gradle 6 build (the Develocity and CCUD plugins are applied) + * `gradle_6.9_and_later` - Applies the convention plugin on a Gradle 6.9 and later build (the Develocity and CCUD plugins are applied) ### Running the example builds diff --git a/convention-develocity-gradle-plugin/examples/gradle_6_and_later/build.gradle b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/build.gradle similarity index 100% rename from convention-develocity-gradle-plugin/examples/gradle_6_and_later/build.gradle rename to convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/build.gradle diff --git a/convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradle/wrapper/gradle-wrapper.jar b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradle/wrapper/gradle-wrapper.jar similarity index 100% rename from convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradle/wrapper/gradle-wrapper.jar rename to convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradle/wrapper/gradle-wrapper.jar diff --git a/convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradle/wrapper/gradle-wrapper.properties b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradle/wrapper/gradle-wrapper.properties similarity index 100% rename from convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradle/wrapper/gradle-wrapper.properties rename to convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradle/wrapper/gradle-wrapper.properties diff --git a/convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradlew b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradlew similarity index 100% rename from convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradlew rename to convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradlew diff --git a/convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradlew.bat b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradlew.bat similarity index 100% rename from convention-develocity-gradle-plugin/examples/gradle_6_and_later/gradlew.bat rename to convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/gradlew.bat diff --git a/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/settings.gradle b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/settings.gradle new file mode 100644 index 0000000000..fdd6a73493 --- /dev/null +++ b/convention-develocity-gradle-plugin/examples/gradle_6.9_and_later/settings.gradle @@ -0,0 +1,12 @@ +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + } +} + +plugins { + id 'com.myorg.convention-develocity-gradle-5-or-newer' version '(,2.0.0)' +} + +rootProject.name = 'example-build' diff --git a/convention-develocity-gradle-plugin/examples/gradle_6/build.gradle b/convention-develocity-gradle-plugin/examples/gradle_6/build.gradle new file mode 100644 index 0000000000..075ba3d563 --- /dev/null +++ b/convention-develocity-gradle-plugin/examples/gradle_6/build.gradle @@ -0,0 +1,3 @@ +plugins { + id 'java' +} diff --git a/convention-develocity-gradle-plugin/examples/gradle_6/gradle/wrapper/gradle-wrapper.jar b/convention-develocity-gradle-plugin/examples/gradle_6/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..e6441136f3 Binary files /dev/null and b/convention-develocity-gradle-plugin/examples/gradle_6/gradle/wrapper/gradle-wrapper.jar differ diff --git a/convention-develocity-gradle-plugin/examples/gradle_6/gradle/wrapper/gradle-wrapper.properties b/convention-develocity-gradle-plugin/examples/gradle_6/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..65a5473b57 --- /dev/null +++ b/convention-develocity-gradle-plugin/examples/gradle_6/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/convention-develocity-gradle-plugin/examples/gradle_6/gradlew b/convention-develocity-gradle-plugin/examples/gradle_6/gradlew new file mode 100755 index 0000000000..b740cf1339 --- /dev/null +++ b/convention-develocity-gradle-plugin/examples/gradle_6/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/convention-develocity-gradle-plugin/examples/gradle_6/gradlew.bat b/convention-develocity-gradle-plugin/examples/gradle_6/gradlew.bat new file mode 100644 index 0000000000..25da30dbde --- /dev/null +++ b/convention-develocity-gradle-plugin/examples/gradle_6/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/convention-develocity-gradle-plugin/examples/gradle_6_and_later/settings.gradle b/convention-develocity-gradle-plugin/examples/gradle_6/settings.gradle similarity index 100% rename from convention-develocity-gradle-plugin/examples/gradle_6_and_later/settings.gradle rename to convention-develocity-gradle-plugin/examples/gradle_6/settings.gradle diff --git a/convention-develocity-maven-extension/README.md b/convention-develocity-maven-extension/README.md index 9841251cb2..3a5e446bde 100644 --- a/convention-develocity-maven-extension/README.md +++ b/convention-develocity-maven-extension/README.md @@ -1,8 +1,30 @@ ## Convention Develocity Maven Extension -This project demonstrates how a convention extension can share the same Develocity build configuration across multiple projects. It -is intended to serve as a starting point for creating your own Maven extension that applies your specific Develocity configuration. Note -the inline comments in the build and source code for things to adjust specifically to your needs. +This project demonstrates how a convention extension can share the same Develocity build configuration across multiple projects. +It is intended to serve as a starting point for creating your own Maven extension that applies your specific Develocity configuration. +Note the inline comments in the build and source code for things to adjust specifically to your needs. + +### Applying the extension to your build + +#### Using a version range + +It's recommended to apply the convention extension using a [version range](https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html). +This approach ensures that the latest version of the extension is resolved, up to the specified maximum version. +For example, the following resolves the latest version of the extension up to, but excluding, version `2.0.0`: + +```xml + + + com.myorg + convention-develocity-maven-extension + (,2.0.0) + + +``` + +This allows you to quickly roll out non-breaking changes to all consumers of the convention extension. +Breaking changes in the extension should be released under a new major version (e.g., `2.0.0`). +All consumers of the extension will then need to update the upper boundary of the version range to the next major version (e.g., `(,3.0.0)`). ### Content diff --git a/convention-develocity-maven-extension/examples/maven_3/.mvn/extensions.xml b/convention-develocity-maven-extension/examples/maven_3/.mvn/extensions.xml index afbc13459d..d8128466c3 100644 --- a/convention-develocity-maven-extension/examples/maven_3/.mvn/extensions.xml +++ b/convention-develocity-maven-extension/examples/maven_3/.mvn/extensions.xml @@ -3,6 +3,6 @@ com.myorg convention-develocity-maven-extension - 1.0.0-SNAPSHOT + (,2.0.0)