improvements to the structure of release-related tasks

Author: sebersole

build.gradle

@@ -40,21 +40,25 @@ plugins {
 
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-// Release Task
-
-tasks.register('release') {
-	description = "The task performed when we are performing a release build.  Relies on " +
-			"the fact that subprojects will appropriately define a release task " +
-			"themselves if they have any release-related activities to perform"
-
-	doFirst {
-		def javaVersionsInUse = jdkVersions.allVersions
-		if (javaVersionsInUse != [JavaLanguageVersion.of(17)].toSet()) {
-			throw new IllegalStateException("Please use JDK 17 to perform the release. Currently using: ${javaVersionsInUse}")
-		}
-	}
+// Releasing
+
+tasks.register( 'releasePrepare' ) {
+	group 'stages'
+	description "Scripted release 'Release Prepare' stage.  " +
+			"Includes various checks as to the publish-ability of the project: testing, generation, etc.  " +
+			"Sub-projects register their own `releasePrepare` to hook into this stage."
+	// See `:release:releasePrepare` which does a lot of heavy lifting here
+}
+
+tasks.register( 'releasePerform' ) {
+	group 'stages'
+	description "Scripted release 'Release Perform' stage.  " +
+			"Generally this entails publishing artifacts to various servers.  " +
+			"Sub-projects register their own `releasePerform` to hook into this stage."
+	// See `:release:releasePerform` which does a lot of heavy lifting here
 }
 
+
 nexusPublishing {
 	repositories {
 		sonatype()

documentation/documentation.gradle

@@ -21,7 +21,6 @@ buildscript {
 
 plugins {
 	id "local.module"
-	id "local.releasable"
 	id "local.javadoc"
 
 	id "org.hibernate.orm.build.reports"
@@ -178,10 +177,6 @@ dependencies {
 if ( hibernateVersion.isSnapshot ) {
 	// only run the ci build tasks for SNAPSHOT versions
 	tasks.register('ciBuild') { dependsOn clean }
-	tasks.release.enabled false
-}
-else {
-	tasks.release.dependsOn clean
 }
 
 

hibernate-platform/hibernate-platform.gradle

@@ -66,9 +66,10 @@ publishingExtension.publications.named("publishedArtifacts", MavenPublication) {
     from components.javaPlatform
 }
 
-tasks.register("publishReleaseArtifacts") {
-    // mirror for `:release:publishReleaseArtifacts`
-    dependsOn tasks.release
+tasks.register("releasePerform") {
+    group "release"
+    description "See :release:releasePerform for details.  Here we hook in publishing to Sonatype"
+
+    dependsOn tasks.publishToSonatype
 }
 
-tasks.release.dependsOn tasks.publishToSonatype

local-build-plugins/src/main/groovy/local.publishing-java-module.gradle

@@ -21,11 +21,6 @@ dependencies {
     javadocSources sourceSets.main.allJava
 }
 
-tasks.register("publishReleaseArtifacts") {
-    // mirror for `:release:publishReleaseArtifacts`
-    dependsOn tasks.release
-}
-
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // Publishing
@@ -37,18 +32,22 @@ publishingExtension.publications.named("publishedArtifacts", MavenPublication) {
 }
 
 
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// Releasing
 
-// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-// Release / publishing tasks
+tasks.register("releasePrepare") {
+    group "release"
+    description "See :release:releasePrepare for details.  Here we hook in testing and checks ensure publish-ability"
 
-tasks.register('ciBuild') {
-    dependsOn test, tasks.publishToSonatype
+    dependsOn tasks.test
+    dependsOn tasks.generateMetadataFileForPublishedArtifactsPublication
+    dependsOn tasks.generatePomFileForPublishedArtifactsPublication
 }
 
-tasks.release.dependsOn tasks.test, tasks.publishToSonatype
+tasks.register( 'releasePerform' ) {
+    group "release"
+    description "See :release:releasePerform for details.  Here we hook in publishing to Sonatype"
 
-tasks.preVerifyRelease.dependsOn build
-tasks.preVerifyRelease.dependsOn generateMetadataFileForPublishedArtifactsPublication
-tasks.preVerifyRelease.dependsOn generatePomFileForPublishedArtifactsPublication
+    dependsOn tasks.publishToSonatype
+}
 
-tasks.publishToSonatype.mustRunAfter test

local-build-plugins/src/main/groovy/local.publishing.gradle

@@ -6,7 +6,6 @@
 plugins {
     id "maven-publish"
     id "signing"
-    id "local.releasable"
 }
 
 // Disable Gradle module metadata publishing until we know what we want.

local-build-plugins/src/main/groovy/local.releasable.gradle

@@ -11,17 +11,11 @@
 import java.io.Serializable;
 import java.util.Properties;
 import java.util.function.Consumer;
-import java.util.function.Supplier;
-
-import org.gradle.api.Project;
-import org.gradle.api.file.RegularFile;
 
 /**
  * @author Steve Ebersole
  */
 public class HibernateVersion implements Serializable {
-	public static final String EXT_KEY = "ormVersion";
-	public static final String VERSION_KEY = "releaseVersion";
 	public static final String RELATIVE_FILE = "gradle/version.properties";
 
 	private final String fullName;
@@ -64,42 +58,22 @@ public boolean isSnapshot() {
 		return isSnapshot;
 	}
 
-	public static HibernateVersion determine(Project project, Supplier<File> versionFileAccess) {
-		if ( project.hasProperty( VERSION_KEY ) ) {
-			final Object version = project.property( VERSION_KEY );
-			if ( version != null ) {
-				return new HibernateVersion( (String) version );
-			}
-		}
-
-		final String fullName = readVersionProperties( versionFileAccess.get() );
-		return new HibernateVersion( fullName );
-	}
-
-	public static HibernateVersion from(Project project, RegularFile versionFile) {
-		return determine( project, versionFile::getAsFile );
-	}
-
-	public static HibernateVersion from(Project project, File versionFile) {
-		return determine( project, () -> versionFile );
-	}
-
-	private static String readVersionProperties(File file) {
-		if ( !file.exists() ) {
+	public static HibernateVersion fromVersionFile(File versionFile) {
+		if ( !versionFile.exists() ) {
 			throw new RuntimeException( "Version file $file.canonicalPath does not exists" );
 		}
 
 		final Properties versionProperties = new Properties();
-		withInputStream( file, (stream) -> {
+		withInputStream( versionFile, (stream) -> {
 			try {
 				versionProperties.load( stream );
 			}
 			catch (IOException e) {
-				throw new RuntimeException( "Unable to load properties from file - " + file.getAbsolutePath(), e );
+				throw new RuntimeException( "Unable to load properties from file - " + versionFile.getAbsolutePath(), e );
 			}
 		} );
 
-		return versionProperties.getProperty( "hibernateVersion" );
+		return new HibernateVersion( versionProperties.getProperty( "hibernateVersion" ) );
 	}
 
 	private static void withInputStream(File file, Consumer<InputStream> action) {

local-build-plugins/src/main/java/org/hibernate/build/HibernateVersion.java

@@ -4,7 +4,12 @@
  */
 package org.hibernate.build;
 
+import org.gradle.api.Project;
+
 import javax.inject.Inject;
+import java.io.File;
+
+import static org.hibernate.build.HibernateVersion.fromVersionFile;
 
 /**
  * @author Steve Ebersole
@@ -13,16 +18,24 @@ public abstract class OrmBuildDetails {
 	private final HibernateVersion hibernateVersion;
 	private final JpaVersion jpaVersion;
 
+	private final ReleaseDetails releaseDetails;
+
 	private final String databaseName;
 
 	@Inject
-	public OrmBuildDetails(
-			HibernateVersion hibernateVersion,
-			JpaVersion jpaVersion,
-			String databaseName) {
-		this.hibernateVersion = hibernateVersion;
-		this.jpaVersion = jpaVersion;
-		this.databaseName = databaseName;
+	public OrmBuildDetails(Project project) {
+		releaseDetails = new ReleaseDetails( project );
+
+		this.hibernateVersion = releaseDetails.getReleaseVersion() != null
+				? releaseDetails.getReleaseVersion()
+				: fromVersionFile( new File( project.getRootDir(), HibernateVersion.RELATIVE_FILE ) );
+
+
+		project.setVersion( hibernateVersion.getFullName() );
+
+		jpaVersion = JpaVersion.from( project );
+
+		databaseName = (String) project.property( "db" );
 	}
 
 	public HibernateVersion getHibernateVersion() {
@@ -41,6 +54,10 @@ public String getHibernateVersionNameOsgi() {
 		return getHibernateVersion().getOsgiVersion();
 	}
 
+	public ReleaseDetails getReleaseDetails() {
+		return releaseDetails;
+	}
+
 	public JpaVersion getJpaVersion() {
 		return jpaVersion;
 	}

local-build-plugins/src/main/java/org/hibernate/build/OrmBuildDetails.java

@@ -0,0 +1,68 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.build;
+
+import org.gradle.api.Project;
+import org.gradle.api.provider.Provider;
+
+/**
+ * @author Steve Ebersole
+ */
+public class ReleaseDetails {
+	private final HibernateVersion releaseVersion;
+	private final HibernateVersion developmentVersion;
+	private final Provider<Boolean> createTagAccess;
+	private final Provider<String> tagNameAccess;
+
+	public ReleaseDetails(Project project) {
+		final Object releaseVersionSetting = project.findProperty( "releaseVersion" );
+		final Object developmentVersionSetting = project.findProperty( "developmentVersion" );
+		if ( releaseVersionSetting != null ) {
+			if ( developmentVersionSetting == null ) {
+				throw new IllegalStateException( "`releaseVersion` with no `developmentVersion`" );
+			}
+			releaseVersion = new HibernateVersion( releaseVersionSetting.toString() );
+			developmentVersion = new HibernateVersion( developmentVersionSetting.toString() );
+			tagNameAccess = project.provider( () -> determineReleaseTag( releaseVersion.getFullName() ) );
+		}
+		else {
+			releaseVersion = null;
+			developmentVersion = null;
+			tagNameAccess = project.provider( () -> null );
+		}
+
+		createTagAccess = project.provider( () -> !project.hasProperty( "noTag" ) );
+	}
+
+	public HibernateVersion getReleaseVersion() {
+		return releaseVersion;
+	}
+
+	public HibernateVersion getDevelopmentVersion() {
+		return developmentVersion;
+	}
+
+	public Provider<Boolean> getCreateTagAccess() {
+		return createTagAccess;
+	}
+
+	public boolean shouldCreateTag() {
+		return getCreateTagAccess().get();
+	}
+
+	public Provider<String> getTagNameAccess() {
+		return tagNameAccess;
+	}
+
+	public String getTagNameToUse() {
+		return getTagNameAccess().get();
+	}
+
+	private static String determineReleaseTag(String releaseVersion) {
+		return releaseVersion.endsWith( ".Final" )
+				? releaseVersion.replace( ".Final", "" )
+				: releaseVersion;
+	}
+}

local-build-plugins/src/main/java/org/hibernate/build/ReleaseDetails.java

@@ -23,13 +23,9 @@ public void apply(Project target) {
 		target.getPluginManager().apply( "base" );
 
 		// read-only details about the build
-		final OrmBuildDetails ormBuildDetails = target.getExtensions().create(
-				"ormBuildDetails",
+		final OrmBuildDetails ormBuildDetails = target.getExtensions().create("ormBuildDetails",
 				OrmBuildDetails.class,
-				HibernateVersion.determine( target, () -> new File( target.getRootDir(), HibernateVersion.RELATIVE_FILE ) ),
-				JpaVersion.from( target ),
-				// default defined in `gradle.properties`
-				target.property( "db" )
+				target
 		);
 
 		target.setGroup( "org.hibernate.orm" );