fix

Author: DavideD

release/build.gradle

@@ -117,134 +117,138 @@ def pushDocChangesTask = tasks.register( 'pushDocChanges', Exec ) {
 
 def uploadDocumentationTask = tasks.register( 'uploadDocumentation' ) {
     description "Upload documentation on the website"
-    dependsOn pushDocChangesTask
     group "Release"
+    dependsOn pushDocChangesTask
 
     doLast {
         logger.lifecycle "Documentation published on '${docPublishRepoUri}' branch '${docPublishBranch}'"
     }
 }
 
-def createTagTask = tasks.register( 'createTag' ) {
-    description "Create local tag"
+def releaseChecksTask = tasks.register( "releaseChecks" ) {
+    description 'Checks and preparation for release'
+    group 'Release'
 
     doFirst {
-        if ( !project.hasProperty( 'releaseVersion' ) || !project.hasProperty( 'developmentVersion' )
-                || !project.hasProperty( 'gitRemote' ) || !project.hasProperty( 'gitBranch' ) ) {
+        logger.lifecycle("Checking that the working tree is clean...")
+        String uncommittedFiles = executeGitCommand('status', '--porcelain')
+        if (!uncommittedFiles.isEmpty()) {
             throw new GradleException(
-                    "Task 'createTag' requires all of the following properties to be set:"
-                            + "'releaseVersion', 'developmentVersion', 'gitRemote' and 'gitBranch'."
+                    "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
             )
         }
-    }
 
-    doLast {
+        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( 'switch', 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( "There are commits on the branch to release that haven't been pushed yet" )
+            throw new GradleException(
+                    "Cannot perform `ciRelease` tasks because there are un-pushed local commits .\n" +
+                            "Push your commits first."
+            )
         }
+    }
+}
 
-        logger.lifecycle( "Commit version update to '${project.releaseVersion}'..." )
-        project.projectVersionFile.text = "projectVersion=${project.releaseVersion}"
-        executeGitCommand( 'add', '.' )
-        executeGitCommand( 'commit', '-m', project.releaseVersion )
+def preVerifyReleaseTask = tasks.register( "preVerifyRelease" ) {
+    group 'Release'
+    description 'Pre-verifies a release job execution (Run locally before a CI release)'
 
-        String tag = project.releaseVersion
-        if ( tag.endsWith( ".Final" ) ) {
-            tag = tag.replace( ".Final", "" )
-        }
-        logger.lifecycle( "Tagging '${tag}'..." )
-        executeGitCommand( 'tag', '-a', '-m', "Release ${project.releaseVersion}", tag )
-    }
+    dependsOn tasks.clean
+    dependsOn assembleDocumentationTask
 }
 
-def updateVersionsTask = tasks.register( "updateVersions" ) {
-    description "Update the release and development version, commit the changes, and create the tag"
-    group "Release"
-    dependsOn createTagTask
+def changeToReleaseVersionTask = tasks.register( 'changeToReleaseVersion' ) {
+    description 'Updates `gradle/version.properties` file to the specified release-version'
+    group 'Release'
+
+    dependsOn releaseChecksTask
 
     doFirst {
-        if ( !project.hasProperty( 'releaseVersion' ) || !project.hasProperty( 'developmentVersion' )
-                || !project.hasProperty( 'gitRemote' ) || !project.hasProperty( 'gitBranch' ) ) {
-            throw new GradleException(
-                    "Task 'releasePrepare' requires all of the following properties to be set:"
-                            + "'releaseVersion', 'developmentVersion', 'gitRemote' and 'gitBranch'."
-            )
-        }
+        logger.lifecycle( "Updating version-file to release-version : `${project.releaseVersion}`" )
+        updateVersionFile( "${project.releaseVersion}" )
     }
+}
 
-    doLast {
-        logger.lifecycle( "Checking that the working tree is clean..." )
-        String uncommittedFiles = executeGitCommand( 'status', '--porcelain' )
-        if ( !uncommittedFiles.isEmpty() ) {
-            throw new GradleException(
-                    "Cannot update the version because there are uncommitted changes in the working tree."
-                            + "\nUncommitted files:\n" + uncommittedFiles
-            )
-        }
+def gitPreparationForReleaseTask = tasks.register( 'gitPreparationForRelease' ) {
+    dependsOn releaseChecksTask
+    dependsOn changeLogFileTask
+    dependsOn changeToReleaseVersionTask
 
-        logger.lifecycle( "Adding commit to update version to '${project.developmentVersion}'..." )
-        project.projectVersionFile.text = "projectVersion=${project.developmentVersion}"
+    doLast {
+        logger.lifecycle( "Performing pre-steps Git commit : `${project.releaseVersion}`" )
         executeGitCommand( 'add', '.' )
-        executeGitCommand( 'commit', '-m', project.developmentVersion )
+        executeGitCommand( 'commit', '-m', "Pre-steps for release : `${project.ormVersion.fullName}`" )
     }
 }
 
-def releasePrepareTask = tasks.register( "releasePrepare" ) {
-    description "On a local checkout, performs all the changes required for the release, website updates included"
-    group "Release"
-    dependsOn updateVersionsTask, commitDocChangesTask
+def changeToDevelopmentVersionTask = tasks.register( 'changeToDevelopmentVersion' ) {
+    description 'Updates `gradle/version.properties` file to the specified development-version'
+    group 'Release'
+
+    dependsOn releaseChecksTask
 
     doFirst {
-        if ( !project.hasProperty( 'releaseVersion' ) || !project.hasProperty( 'developmentVersion' )
-                || !project.hasProperty( 'gitRemote' ) || !project.hasProperty( 'gitBranch' ) ) {
-            throw new GradleException(
-                    "Task 'releasePrepare' requires all of the following properties to be set:"
-                            + "'releaseVersion', 'developmentVersion', 'gitRemote' and 'gitBranch'."
-            )
-        }
+        logger.lifecycle( "Updating version-file to development-version : `${project.developmentVersion}`" )
+        updateVersionFile( "${project.developmentVersion}" )
     }
 }
 
-def pushChangesTask = tasks.register( "pushChanges" ) {
-    description "Push the changes after preparing the release"
-    dependsOn releasePrepareTask
-
-    doFirst {
-        if ( !project.hasProperty( 'releaseVersion' ) || !project.hasProperty( 'developmentVersion' )
-                || !project.hasProperty( 'gitRemote' ) || !project.hasProperty( 'gitBranch' ) ) {
-            throw new GradleException(
-                    "Task 'ciRelease' requires all of the following properties to be set:"
-                            + "'releaseVersion', 'developmentVersion', 'gitRemote' and 'gitBranch'."
-            )
-        }
-    }
+def releasePreparePostGitTask = tasks.register( 'gitTasksAfterRelease' ) {
+    dependsOn changeToDevelopmentVersionTask
 
     doLast {
-        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."
-                            + "\nCommit or stash your changes first."
-                            + "\nUncommitted files:\n" + uncommittedFiles
-            )
-        }
-        String tag = project.releaseVersion
-        if ( tag.endsWith( ".Final" ) ) {
-            tag = tag.replace( ".Final", "" )
+        if ( project.createTag ) {
+            logger.lifecycle( "Tagging release : `${project.releaseTag}`..." )
+            executeGitCommand( 'tag', '-a', project.releaseTag, '-m', "Release $project.projectVersion.fullName" )
         }
-        logger.lifecycle( "Pushing branch and tag to remote '${project.gitRemote}'..." )
-        executeGitCommand( 'push', '--atomic', project.gitRemote, project.gitBranch, tag )
-        logger.lifecycle( "Done!" )
+
+        logger.lifecycle( "Performing post-steps Git commit : `${project.releaseVersion}`" )
+        executeGitCommand( 'add', '.' )
+        executeGitCommand( 'commit', '-m', "Post-steps for release : `${project.projectVersion.fullName}`" )
     }
 }
 
+void updateVersionFile(String version) {
+    logger.lifecycle( "Updating `gradle/version.properties` version to `${version}`" )
+    project.projectVersionFile.text = "projectVersion=${version}"
+}
+
+def publishReleaseArtifactsTask = tasks.register( 'publishReleaseArtifacts' ) {
+    mustRunAfter gitPreparationForReleaseTask
+
+    dependsOn uploadDocumentationTask
+}
+
 def releasePerformPostGitTask = tasks.register( 'gitTasksAfterReleasePerform' ) {
+
     doLast {
         if ( project.createTag ) {
             logger.lifecycle( "Pushing branch and tag to remote `${project.gitRemote}`..." )
@@ -257,12 +261,21 @@ def releasePerformPostGitTask = tasks.register( 'gitTasksAfterReleasePerform' )
     }
 }
 
+def releasePrepareTask = tasks.register( "releasePrepare" ) {
+    description "On a local checkout, performs all the changes required for the release, website updates included"
+    group "Release"
+
+    dependsOn assembleDocumentationTask
+    dependsOn commitDocChangesTask
+
+    finalizedBy releasePreparePostGitTask
+}
+
 def releasePerformTask = tasks.register( 'releasePerform' ) {
     group 'Release'
     description 'Performs a release on local check-out, including updating changelog and '
 
-    mustRunAfter releasePrepareTask
-    dependsOn uploadDocumentationTask
+    dependsOn publishReleaseArtifactsTask
 
     finalizedBy releasePerformPostGitTask
 }
@@ -273,12 +286,15 @@ def releasePerformTask = tasks.register( 'releasePerform' ) {
 def releaseTask = tasks.register( 'release' ) {
     description 'Performs a release on local check-out'
     group 'Release'
-    dependsOn pushChangesTask
+
+    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."
     group "Release"
+
     dependsOn releaseTask
 }
 
@@ -350,12 +366,12 @@ gradle.getTaskGraph().whenReady {tg->
             }
         }
 
-        assert releaseVersionLocal != null && developmentVersionLocal != null;
+        assert releaseVersionLocal != null && developmentVersionLocal != null
 
         // set up information for the release-related tasks
         project.ext {
-            releaseVersion = releaseVersionLocal;
-            developmentVersion = developmentVersionLocal;
+            releaseVersion = releaseVersionLocal
+            developmentVersion = developmentVersionLocal
             createTag = !project.hasProperty('noTag')
             releaseTag = project.createTag ? determineReleaseTag(releaseVersionLocal) : ''
         }
@@ -365,5 +381,5 @@ gradle.getTaskGraph().whenReady {tg->
 static String determineReleaseTag(String releaseVersion) {
     return releaseVersion.endsWith( '.Final' )
             ? releaseVersion.replace( ".Final", "" )
-            : releaseVersion;
+            : releaseVersion
 }