improvements to the structure of release-related tasks

Author: sebersole

build.gradle

@@ -43,15 +43,15 @@ plugins {
 // Releasing
 
 tasks.register( 'releasePrepare' ) {
-	group 'stages'
+	group "release-prepare"
 	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'
+	group "release-perform"
 	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."

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

@@ -35,19 +35,26 @@ publishingExtension.publications.named("publishedArtifacts", MavenPublication) {
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // Releasing
 
-tasks.register("releasePrepare") {
+def releasePrepareTask = tasks.register("releasePrepare") {
     group "release"
     description "See :release:releasePrepare for details.  Here we hook in testing and checks ensure publish-ability"
 
-    dependsOn tasks.test
+    dependsOn tasks.check
     dependsOn tasks.generateMetadataFileForPublishedArtifactsPublication
     dependsOn tasks.generatePomFileForPublishedArtifactsPublication
 }
 
+// used from the h2 CI job
+tasks.register("preVerifyRelease") {
+    group "release-prepare"
+    description "Delegates to `releasePrepare` task"
+
+    dependsOn releasePrepareTask
+}
+
 tasks.register( 'releasePerform' ) {
-    group "release"
+    group "release-perform"
     description "See :release:releasePerform for details.  Here we hook in publishing to Sonatype"
 
     dependsOn tasks.publishToSonatype
 }
-

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

@@ -5,6 +5,8 @@
 package org.hibernate.build;
 
 import org.gradle.api.Project;
+import org.gradle.api.file.RegularFile;
+import org.gradle.api.provider.Provider;
 
 import javax.inject.Inject;
 import java.io.File;
@@ -15,29 +17,33 @@
  * @author Steve Ebersole
  */
 public abstract class OrmBuildDetails {
+	private final ReleaseDetails releaseDetails;
+	private final Provider<File> versionFileAccess;
 	private final HibernateVersion hibernateVersion;
-	private final JpaVersion jpaVersion;
 
-	private final ReleaseDetails releaseDetails;
+	private final JpaVersion jpaVersion;
 
 	private final String databaseName;
 
 	@Inject
 	public OrmBuildDetails(Project project) {
 		releaseDetails = new ReleaseDetails( project );
+		versionFileAccess = project.provider( () -> new File( project.getRootDir(), HibernateVersion.RELATIVE_FILE ) );
 
-		this.hibernateVersion = releaseDetails.getReleaseVersion() != null
+		hibernateVersion = releaseDetails.getReleaseVersion() != null
 				? releaseDetails.getReleaseVersion()
-				: fromVersionFile( new File( project.getRootDir(), HibernateVersion.RELATIVE_FILE ) );
-
-
+				: fromVersionFile( versionFileAccess.get() );
 		project.setVersion( hibernateVersion.getFullName() );
 
 		jpaVersion = JpaVersion.from( project );
 
 		databaseName = (String) project.property( "db" );
 	}
 
+	public Provider<File> getVersionFileAccess() {
+		return versionFileAccess;
+	}
+
 	public HibernateVersion getHibernateVersion() {
 		return hibernateVersion;
 	}

release/release.gradle

@@ -18,9 +18,6 @@ plugins {
     id "idea"
 }
 
-def hibernateVersion = ormBuildDetails.hibernateVersion
-def releaseDetails = ormBuildDetails.releaseDetails
-
 idea.module {
 }
 
@@ -48,7 +45,7 @@ tasks.build.enabled false
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 def releaseChecksTask = tasks.register( "releaseChecks" ) {
-    group 'prepare'
+    group 'release-prepare'
     description 'Checks and preparation for release'
 
     doFirst {
@@ -105,79 +102,78 @@ def releaseChecksTask = tasks.register( "releaseChecks" ) {
 }
 
 def changeLogFileTask = tasks.register( "changeLogFile" ) {
-    group 'Release'
+    group 'release-prepare'
     description 'Updates the changelog.txt file based on the change-log report from Jira'
     dependsOn releaseChecksTask
 
     doFirst {
         logger.lifecycle( "Appending version `${project.releaseVersion}` to changelog..." )
-        ChangeLogFile.update( hibernateVersion.fullName );
+        ChangeLogFile.update( ormBuildDetails.hibernateVersion.fullName );
     }
 }
 
 def changeToReleaseVersionTask = tasks.register( "changeToReleaseVersion" ) {
-    group 'Release'
+    group 'release-prepare'
     description 'Updates `gradle/version.properties` file to the specified release-version'
 
     dependsOn releaseChecksTask
 
     doFirst {
-        logger.lifecycle( "Updating version-file to release-version : `${project.releaseVersion}`" )
-        updateVersionFile( project.releaseVersion )
+        def releaseVersion = ormBuildDetails.releaseDetails.releaseVersion
+        logger.lifecycle( "Updating version-file to release-version : `${releaseVersion}`" )
+        updateVersionFile( releaseVersion )
     }
 }
 
 def gitPreStepsTask = tasks.register( 'gitPreSteps' ) {
-    group "prepare"
+    group "release-prepare"
     description "update changelog, update version file and commit"
 
     dependsOn releaseChecksTask
     dependsOn changeLogFileTask
     dependsOn changeToReleaseVersionTask
 
     doLast {
-        logger.lifecycle( "Performing pre-steps Git commit : `${project.releaseVersion}`" )
+        def releaseVersion = ormBuildDetails.releaseDetails.releaseVersion
+        logger.lifecycle( "Performing pre-steps Git commit : `${releaseVersion}`" )
         executeGitCommand( 'add', '.' )
-        executeGitCommand( 'commit', '-m', "Pre-steps for release : `${hibernateVersion.fullName}`" )
+        executeGitCommand( 'commit', '-m', "Pre-steps for release : `${releaseVersion.fullName}`" )
     }
 }
 
-def changeToDevelopmentVersionTask = tasks.register( 'changeToDevelopmentVersion' ) {
-    group 'Release'
-    description 'Updates `gradle/version.properties` file to the specified development-version'
-
-    dependsOn releaseChecksTask
+def gitPostStepsTask = tasks.register( 'gitPostSteps' ) {
+    group "release-prepare"
+    description "possibly create tag. update version-file and commit "
 
     doFirst {
-        logger.lifecycle( "Updating version-file to development-version : `${project.developmentVersion}`" )
-        updateVersionFile( project.developmentVersion )
     }
-}
-
-def gitPostStepsTask = tasks.register( 'gitPostSteps' ) {
-    group "prepare"
-    description "possibly create tag. update version-file and commit "
-    dependsOn changeToDevelopmentVersionTask
 
     doLast {
+        def releaseDetails = ormBuildDetails.releaseDetails
+        def releaseVersion = releaseDetails.releaseVersion
+        def developmentVersion = releaseDetails.developmentVersion
+
         if ( releaseDetails.shouldCreateTag ) {
-            logger.lifecycle( "Tagging release : `${project.releaseTag}`..." )
-            executeGitCommand( 'tag', '-a', project.releaseTag, '-m', "Release $hibernateVersion.fullName" )
+            logger.lifecycle( "Tagging release : `${releaseDetails.tagNameToUse}`..." )
+            executeGitCommand( 'tag', '-a', releaseDetails.tagNameToUse, '-m', "Release $releaseVersion.fullName" )
         }
 
-        logger.lifecycle( "Performing post-steps Git commit : `${project.releaseVersion}`" )
+        logger.lifecycle( "Updating version-file to development-version : `${developmentVersion.fullName}`" )
+        updateVersionFile( developmentVersion )
+
+        logger.lifecycle( "Performing post-steps Git commit : `${releaseVersion}`" )
         executeGitCommand( 'add', '.' )
-        executeGitCommand( 'commit', '-m', "Post-steps for release : `${hibernateVersion.fullName}`" )
+        executeGitCommand( 'commit', '-m', "Post-steps for release : `${releaseVersion.fullName}`" )
     }
 }
 
 void updateVersionFile(String version) {
     logger.lifecycle( "Updating `gradle/version.properties` version to `${version}`" )
-    project.extensions.ormBuildDetails.versionFile.get().text = "hibernateVersion=${version}"
+    ormBuildDetails.versionFileAccess.get().text = "ormBuildDetails.hibernateVersion=${version}"
 }
 
 tasks.register("releasePrepare") {
-    group "stages"
+    group "release-prepare"
     description "Scripted release 'Release Prepare' stage"
 
     dependsOn releaseChecksTask
@@ -387,12 +383,12 @@ def assembleDocumentationTask = tasks.register( "assembleDocumentation" ) {
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 def uploadDocumentationTask = tasks.named( "uploadDocumentation" ) {
-    group = "documentation"
+    group = "release-perform"
     description = "Uploads assembled documentation to the doc server"
     dependsOn assembleDocumentationTask
 
     doFirst {
-        if ( hibernateVersion.isSnapshot ) {
+        if ( ormBuildDetails.hibernateVersion.isSnapshot ) {
             logger.error( "Cannot perform upload of SNAPSHOT documentation" );
             throw new RuntimeException( "Cannot perform upload of SNAPSHOT documentation" );
         }
@@ -407,14 +403,14 @@ def uploadDocumentationTask = tasks.named( "uploadDocumentation" ) {
 }
 
 tasks.register( 'releasePerform' ) {
-    group 'stages'
+    group = "release-perform"
     description "Scripted release 'Release Perform' stage"
 
     dependsOn uploadDocumentationTask
     dependsOn uploadDocumentationDescriptor
 
     doLast {
-        if ( releaseDetails.shouldCreateTag ) {
+        if ( ormBuildDetails.releaseDetails.shouldCreateTag ) {
             logger.lifecycle( "Pushing branch and tag to remote `${project.gitRemote}`..." )
             executeGitCommand( 'push', '--atomic', project.gitRemote, project.gitBranch, project.releaseTag )
         }

tooling/hibernate-gradle-plugin/hibernate-gradle-plugin.gradle

@@ -65,15 +65,23 @@ test {
 	}
 }
 
-tasks.register("releasePrepare") {
-	group "release"
-	description "See :release:releasePrepare for details.  Here we hook in testing"
+def releasePrepareTask = tasks.register("releasePrepare") {
+	group "release-prepare"
+	description "See :release:releasePrepare for details.  Here we hook in the `check` task."
 
-	dependsOn tasks.test
+	dependsOn tasks.check
+}
+
+// used from the h2 CI job
+tasks.register("preVerifyRelease") {
+	group "release-prepare"
+	description "Delegates to `releasePrepare` task"
+
+	dependsOn releasePrepareTask
 }
 
 tasks.register("releasePerform") {
-	group "release"
+	group "release-perform"
 	description "See :release:releasePerform for details.  Here we hook in publishing to the Plugin Portal"
 
 	dependsOn tasks.publishPlugins

tooling/hibernate-maven-plugin/hibernate-maven-plugin.gradle

@@ -22,6 +22,28 @@ dependencies {
     implementation "org.apache.maven.shared:file-management:3.1.0"
 }
 
+def releasePrepareTask = tasks.register("releasePrepare") {
+    group "release-prepare"
+    description "See :release:releasePrepare for details.  Here we hook in the `check` task."
+
+    dependsOn tasks.check
+}
+
+// used from the h2 CI job
+tasks.register("preVerifyRelease") {
+    group "release-prepare"
+    description "Delegates to `releasePrepare` task"
+
+    dependsOn releasePrepareTask
+}
+
+tasks.register( 'releasePerform' ) {
+    group "release-perform"
+    description "See :release:releasePerform for details.  Here we hook in publishing to Sonatype"
+
+    dependsOn tasks.publishAllPublicationsToSonatypeRepository
+}
+
 var publishingExtension = project.getExtensions().getByType(PublishingExtension) as PublishingExtension
 publishingExtension.publications.named("publishedArtifacts") {
     from components.java