[4.2] Simplify the release process

ci/release/Jenkinsfile

@@ -178,7 +178,7 @@ pipeline {
 							configFile(fileId: 'release.config.ssh', targetLocation: "${env.HOME}/.ssh/config"),
 							configFile(fileId: 'release.config.ssh.knownhosts', targetLocation: "${env.HOME}/.ssh/known_hosts")
 					]) {
-						sshagent(['ed25519.Hibernate-CI.github.com', 'hibernate.filemgmt.jboss.org', 'hibernate-ci.frs.sourceforge.net']) {
+						sshagent(['ed25519.Hibernate-CI.github.com']) {
 							// set release version
 							// update changelog from JIRA
 							// tags the version
@@ -211,13 +211,14 @@ pipeline {
 								string(credentialsId: 'release.gpg.passphrase', variable: 'JRELEASER_GPG_PASSPHRASE'),
 								string(credentialsId: 'Hibernate-CI.github.com', variable: 'JRELEASER_GITHUB_TOKEN')
 						]) {
-							sshagent(['ed25519.Hibernate-CI.github.com', 'hibernate.filemgmt.jboss.org', 'jenkins.in.relation.to', 'hibernate-ci.frs.sourceforge.net']) {
+							sshagent(['ed25519.Hibernate-CI.github.com', 'jenkins.in.relation.to']) {
 								// performs documentation upload and Sonatype release
 								// push to github
 								withEnv([
 										"DISABLE_REMOTE_GRADLE_CACHE=true"
 								]) {
-									sh ".release/scripts/publish.sh -j ${env.SCRIPT_OPTIONS} ${env.PROJECT} ${env.RELEASE_VERSION} ${env.DEVELOPMENT_VERSION} ${env.GIT_BRANCH}"
+									def ghReleaseNote = sh('realpath -e github_release_notes.md 2>/dev/null', returnStdout: true).trim()
+									sh ".release/scripts/publish.sh -j ${ghReleaseNote != '' ? '--notes=' + ghReleaseNote : ''} ${env.SCRIPT_OPTIONS} ${env.PROJECT} ${env.RELEASE_VERSION} ${env.DEVELOPMENT_VERSION} ${env.GIT_BRANCH}"
 								}
 							}
 						}
@@ -237,7 +238,7 @@ pipeline {
 						withCredentials([
 								gitUsernamePassword(credentialsId: 'username-and-token.Hibernate-CI.github.com', gitToolName: 'Default')
 						]) {
-							sshagent( ['ed25519.Hibernate-CI.github.com', 'hibernate.filemgmt.jboss.org', 'hibernate-ci.frs.sourceforge.net'] ) {
+							sshagent( ['ed25519.Hibernate-CI.github.com'] ) {
 								dir( '.release/hibernate.org' ) {
 									checkout scmGit(
 											branches: [[name: '*/production']],

documentation/build.gradle

@@ -182,6 +182,9 @@ def renderReferenceDocumentationTask = tasks.register( "renderReferenceDocumenta
 			"html-meta-version-family": versionFamily.get(),
 	)
 
+	// See https://docs.asciidoctor.org/gradle-plugin/latest/common-task-configuration/#choosing-an-execution-mode-for-asciidoctorj
+	executionMode = org.ysb33r.grolifant.api.core.jvm.ExecutionMode.JAVA_EXEC
+
 	dependsOn( tasks.named( "unpackTheme" ) )
 }
 

github_release_notes.md

@@ -0,0 +1,3 @@
+
+* See the [website](https://hibernate.org/reactive/releases/{{releaseVersionFamily}}) for requirements and compatibilities.
+* See the [What's New](https://hibernate.org/reactive/releases/{{releaseVersionFamily}}/#whats-new) guide for details about new features and capabilities.

publish.gradle

@@ -97,3 +97,11 @@ publishing {
         }
     }
 }
+
+def releasePrepareTask = tasks.register("releasePrepare") {
+	description "Prepares all the artifacts and documentation for a JReleaser release."
+	group "Release"
+
+	// Create all the published artifacts (i.e. jars) and move them to the staging directory (for JReleaser):
+	dependsOn publishAllPublicationsToStagingRepository
+}

release/build.gradle

@@ -19,61 +19,6 @@ description = 'Release module'
 // The folder containing the rendered documentation
 final Directory documentationDir = project(":documentation").layout.buildDirectory.get()
 
-// Relative path on the static website where the documentation is located
-final String docWebsiteRelativePath = "reactive/documentation/${projectVersion.family}"
-
-def releaseChecksTask = tasks.register( "releaseChecks" ) {
-    description 'Checks and preparation for release'
-    group 'Release'
-
-    doFirst {
-        logger.lifecycle("Checking that the working tree is clean...")
-        String uncommittedFiles = executeGitCommand('status', '--porcelain')
-        if (!uncommittedFiles.isEmpty()) {
-            throw new GradleException(
-                    "Cannot release because there are uncommitted or untracked files in the working tree.\n" +
-                            "Commit or stash your changes first.\n" +
-                            "Uncommitted files:\n    " +
-                            uncommittedFiles
-            )
-        }
-
-        String gitBranchLocal = project.hasProperty( 'gitBranch' ) && !project.property( 'gitBranch' ).isEmpty()
-                ? project.property( 'gitBranch' )
-                : executeGitCommand( 'branch', '--show-current' ).trim()
-
-        String gitRemoteLocal
-        if ( project.hasProperty( 'gitRemote' ) && !project.property( 'gitRemote' ).isEmpty() ) {
-            gitRemoteLocal = project.property( 'gitRemote' )
-        }
-        else {
-            final String remotes = executeGitCommand( 'remote', 'show' ).trim()
-            final List<String> tokens = remotes.tokenize()
-            if ( tokens.size() != 1 ) {
-                throw new GradleException( "Could not determine `gitRemote` property for `releaseChecks` tasks." )
-            }
-            gitRemoteLocal = tokens.get( 0 )
-        }
-
-        project.ext {
-            gitBranch = gitBranchLocal
-            gitRemote = gitRemoteLocal
-        }
-
-        logger.lifecycle( "Switching to branch '${project.gitBranch}'..." )
-        executeGitCommand( 'checkout', project.gitBranch )
-
-        logger.lifecycle( "Checking that all commits are pushed..." )
-        String diffWithUpstream = executeGitCommand( 'diff', '@{u}' )
-        if ( !diffWithUpstream.isEmpty() ) {
-            throw new GradleException(
-                    "Cannot perform `ciRelease` tasks because there are un-pushed local commits .\n" +
-                            "Push your commits first."
-            )
-        }
-    }
-}
-
 /**
  * Assembles all documentation into the {buildDir}/documentation directory.
  */
@@ -84,22 +29,9 @@ def assembleDocumentationTask = tasks.register( 'assembleDocumentation' ) {
 }
 assemble.dependsOn assembleDocumentationTask
 
-def changeToReleaseVersionTask = tasks.register( 'changeToReleaseVersion' ) {
-    description 'Updates `gradle/version.properties` file to the specified release-version'
-    group 'Release'
-
-    dependsOn releaseChecksTask
-
-    doFirst {
-        logger.lifecycle( "Updating version-file to release-version : `${project.releaseVersion}`" )
-        updateVersionFile( "${project.releaseVersion}" )
-    }
-}
-
 def updateDocumentationTask = tasks.register( 'updateDocumentation' ) {
     description "Update the documentation on the cloned static website"
     dependsOn assembleDocumentationTask
-    mustRunAfter changeToReleaseVersion
 
     // copy documentation outputs into target/documentation:
     // * this is used in building the dist bundles
@@ -120,188 +52,13 @@ def updateDocumentationTask = tasks.register( 'updateDocumentation' ) {
     }
 }
 
-def gitPreparationForReleaseTask = tasks.register( 'gitPreparationForRelease' ) {
-    dependsOn releaseChecksTask, changeToReleaseVersionTask
-    finalizedBy updateDocumentationTask
-
-    doLast {
-        logger.lifecycle( "Performing pre-steps Git commit : `${project.releaseVersion}`" )
-        executeGitCommand( 'add', '.' )
-        executeGitCommand( 'commit', '-m', "Update project version to : `${project.releaseVersion}`" )
-    }
-}
-
-def changeToDevelopmentVersionTask = tasks.register( 'changeToDevelopmentVersion' ) {
-    description 'Updates `gradle/version.properties` file to the specified development-version'
-    group 'Release'
-
-    dependsOn releaseChecksTask
-
-    doFirst {
-        logger.lifecycle( "Updating version-file to development-version : `${project.developmentVersion}`" )
-        updateVersionFile( "${project.developmentVersion}" )
-    }
-}
-
-def releasePreparePostGitTask = tasks.register( 'gitTasksAfterRelease' ) {
-    dependsOn changeToDevelopmentVersionTask
-
-    doLast {
-        if ( project.createTag ) {
-            logger.lifecycle( "Tagging release : `${project.releaseTag}`..." )
-            executeGitCommand( 'tag', '-a', project.releaseTag, '-m', "Release $project.projectVersion" )
-        }
-
-        logger.lifecycle( "Performing post-steps Git commit : `${project.releaseVersion}`" )
-        executeGitCommand( 'add', '.' )
-        executeGitCommand( 'commit', '-m', "Update project version to : `${project.developmentVersion}`" )
-    }
-}
-
-void updateVersionFile(var version) {
-    logger.lifecycle( "Updating `gradle/version.properties` version to `${version}`" )
-    project.versionFile.text = "projectVersion=${version}"
-    project.version = version
-}
-
-def publishReleaseArtifactsTask = tasks.register( 'publishReleaseArtifacts' ) {
-    dependsOn updateDocumentationTask
-
-    mustRunAfter gitPreparationForReleaseTask
-}
-
-def releasePerformPostGitTask = tasks.register( 'gitTasksAfterReleasePerform' ) {
-
-    doLast {
-        if ( project.createTag ) {
-            logger.lifecycle( "Pushing branch and tag to remote `${project.gitRemote}`..." )
-            executeGitCommand( 'push', '--atomic', project.gitRemote, project.gitBranch, project.releaseTag )
-        }
-        else {
-            logger.lifecycle( "Pushing branch to remote `${project.gitRemote}`..." )
-            executeGitCommand( 'push', project.gitRemote, project.gitBranch )
-        }
-    }
-}
-
 def releasePrepareTask = tasks.register( "releasePrepare" ) {
-    description "On a local checkout, performs all the changes required for the release, website updates included"
-    group "Release"
-
-    dependsOn gitPreparationForReleaseTask
-
-    finalizedBy releasePreparePostGitTask
-}
-
-def releasePerformTask = tasks.register( 'releasePerform' ) {
-    group 'Release'
-    description 'Performs a release on local check-out, including updating changelog and '
-
-    dependsOn publishReleaseArtifactsTask
-
-    finalizedBy releasePerformPostGitTask
-}
-
-/*
-* Release everything
-*/
-def releaseTask = tasks.register( 'release' ) {
-    description 'Performs a release on local check-out'
-    group 'Release'
-
-    dependsOn releasePrepareTask
-    dependsOn releasePerformTask
-}
-
-def ciReleaseTask = tasks.register( 'ciRelease' ) {
-    description "Triggers the release on CI: creates commits to change the version (release, then development), creates a tag, pushes everything. Then CI will take over and perform the release."
+    description "Prepares all the artifacts and documentation for a JReleaser release."
     group "Release"
 
-    dependsOn releaseTask
-}
-
-static String executeGitCommand(Object ... subcommand){
-    List<Object> command = ['git']
-    Collections.addAll( command, subcommand )
-    def proc = command.execute()
-    def code = proc.waitFor()
-    def stdout = inputStreamToString( proc.getInputStream() )
-    def stderr = inputStreamToString( proc.getErrorStream() )
-    if ( code != 0 ) {
-        throw new GradleException( "An error occurred while executing " + command + "\n\nstdout:\n" + stdout + "\n\nstderr:\n" + stderr )
-    }
-    return stdout
-}
-
-static String inputStreamToString(InputStream inputStream) {
-    inputStream.withCloseable { ins ->
-        new BufferedInputStream(ins).withCloseable { bis ->
-            new ByteArrayOutputStream().withCloseable { buf ->
-                int result = bis.read()
-                while (result != -1) {
-                    buf.write((byte) result)
-                    result = bis.read()
-                }
-                return buf.toString(StandardCharsets.UTF_8.name())
-            }
-        }
-    }
-}
-
-gradle.getTaskGraph().whenReady { tg->
-    if ( ( tg.hasTask( project.tasks.releasePrepare ) || tg.hasTask( project.tasks.releasePerform ) )
-            && ! project.getGradle().getStartParameter().isDryRun() ) {
-        String releaseVersionLocal
-        String developmentVersionLocal
-
-        def console = tg.hasTask( project.tasks.release ) && !tg.hasTask( project.tasks.ciRelease )
-                ? System.console()
-                : null
-
-        if (project.hasProperty('releaseVersion')) {
-            releaseVersionLocal = project.property('releaseVersion')
-        }
-        else {
-            if (console) {
-                // prompt for `releaseVersion`
-                releaseVersionLocal = console.readLine('> Enter the release version: ')
-            }
-            else {
-                throw new GradleException(
-                        "`release`-related tasks require the following properties: 'releaseVersion', 'developmentVersion'"
-                )
-            }
-        }
-
-        if (project.hasProperty('developmentVersion')) {
-            developmentVersionLocal = project.property('developmentVersion')
-        }
-        else {
-            if (console) {
-                // prompt for `developmentVersion`
-                developmentVersionLocal = console.readLine('> Enter the next development version: ')
-            }
-            else {
-                throw new GradleException(
-                        "`release`-related tasks require the following properties: 'releaseVersion', 'developmentVersion'"
-                )
-            }
-        }
-
-        assert releaseVersionLocal != null && developmentVersionLocal != null
-
-        // set up information for the release-related tasks
-        project.ext {
-            releaseVersion = releaseVersionLocal
-            developmentVersion = developmentVersionLocal
-            createTag = !project.hasProperty('noTag')
-            releaseTag = project.createTag ? determineReleaseTag(releaseVersionLocal) : ''
-        }
-    }
-}
-
-static String determineReleaseTag(String releaseVersion) {
-    return releaseVersion.endsWith( '.Final' )
-            ? releaseVersion.replace( ".Final", "" )
-            : releaseVersion
+	// Render the Documentation/Javadocs and move them to the staging directory (for JReleaser):
+	dependsOn updateDocumentationTask
+	// Create all the published artifacts (i.e. jars) and move them to the staging directory (for JReleaser):
+	// this one is defined in the publish.gradle
+	// dependsOn project.getTasksByName(publishAllPublicationsToStagingRepository, false)
 }