added support to gradle's configuration avoidance api (#76)

## Description Added support for Gradle's "Configuration Avoidance API". It eases the burden on Gradle configuration step by assuring that a task configuration will only be executed prior to the task execution itself. Thus, if a task isn't predicted to be executed, its configuration won't be loaded. More details on https://docs.gradle.org/current/userguide/task_configuration_avoidance.html ## Changes * ![IMPROVE] Added support for Gradle's [Configuration Avoidance API](https://docs.gradle.org/current/userguide/task_configuration_avoidance.html)
wooga · May 10, 2021 · 6bf4327 · 6bf4327
1 parent 1f5d825
commit 6bf4327
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 35 deletions.
diff --git a/src/integrationTest/groovy/wooga/gradle/github/GithubPublishIntegrationSpec.groovy b/src/integrationTest/groovy/wooga/gradle/github/GithubPublishIntegrationSpec.groovy
@@ -343,7 +343,7 @@ class GithubPublishIntegrationSpec extends GithubPublishIntegrationWithDefaultAu
         """
 
         when:
-        runTasksSuccessfully("testPublish")
+        def result = runTasksSuccessfully("testPublish")
 
         then:
         def release = getRelease(tagName)
@@ -357,7 +357,7 @@ class GithubPublishIntegrationSpec extends GithubPublishIntegrationWithDefaultAu
         assets.any { it.name == "initial.json" }
 
         when:
-        runTasksSuccessfully("testPublishOrUpdate")
+        result = runTasksSuccessfully("testPublishOrUpdate")
 
         then:
         def updatedRelease = getRelease(tagName)

diff --git a/src/main/groovy/wooga/gradle/github/base/GithubBasePlugin.groovy b/src/main/groovy/wooga/gradle/github/base/GithubBasePlugin.groovy
@@ -85,15 +85,12 @@ class GithubBasePlugin implements Plugin<Project> {
             null
         }))
 
-        project.tasks.withType(AbstractGithubTask, new Action<AbstractGithubTask>() {
-            @Override
-            void execute(AbstractGithubTask task) {
-                task.baseUrl.set(extension.baseUrl)
-                task.repositoryName.set(extension.repositoryName)
-                task.username.set(extension.username)
-                task.password.set(extension.password)
-                task.token.set(extension.token)
-            }
-        })
+        project.tasks.withType(AbstractGithubTask).configureEach { task ->
+            task.baseUrl.set(extension.baseUrl)
+            task.repositoryName.set(extension.repositoryName)
+            task.username.set(extension.username)
+            task.password.set(extension.password)
+            task.token.set(extension.token)
+        }
     }
 }
diff --git a/src/main/groovy/wooga/gradle/github/publish/GithubPublishPlugin.groovy b/src/main/groovy/wooga/gradle/github/publish/GithubPublishPlugin.groovy
@@ -72,31 +72,27 @@ class GithubPublishPlugin implements Plugin<Project> {
     }
 
     private static void createDefaultPublishTask(final TaskContainer tasks) {
-        def githubPublish = tasks.create(name: PUBLISH_TASK_NAME, type: GithubPublish, group: GithubBasePlugin.GROUP)
-        githubPublish.description = "Publish github release"
-        tasks.getByName(PublishingPlugin.PUBLISH_LIFECYCLE_TASK_NAME).dependsOn githubPublish
+        def githubPublish = tasks.register(PUBLISH_TASK_NAME, GithubPublish)
+        githubPublish.configure { GithubPublish task ->
+            task.group = GithubBasePlugin.GROUP
+            task.description = "Publish github release"
+        }
+        tasks.named(PublishingPlugin.PUBLISH_LIFECYCLE_TASK_NAME).configure {task ->
+            task.dependsOn(githubPublish)
+        }
     }
 
     private static void configurePublishTaskDefaults(final Project project) {
-        project.tasks.withType(GithubPublish, new Action<GithubPublish>() {
-            @Override
-            void execute(GithubPublish task) {
-                task.prerelease.convention(GithubPublishPluginConvention.defaultPublishPrerelease)
-                task.draft.convention(GithubPublishPluginConvention.defaultPublishDraft)
-                task.publishMethod.convention(GithubPublishPluginConvention.defaultPublishMethod)
+        def projectProvider = project.provider({ project.version.toString() })
+        project.tasks.withType(GithubPublish).configureEach {task ->
+            task.prerelease.set(false)
+            task.draft.set(false)
+            task.publishMethod.set(PublishMethod.create)
 
-                def projectProvider = project.provider({ project.version.toString() })
+            task.tagName.set(projectProvider)
+            task.releaseName.set(projectProvider)
 
-                task.tagName.convention(projectProvider)
-                task.releaseName.convention(projectProvider)
-
-                task.onlyIf(new Spec<GithubPublish>() {
-                    @Override
-                    boolean isSatisfiedBy(GithubPublish publishTask) {
-                        publishTask.repositoryName.present
-                    }
-                })
-            }
-        })
+            task.onlyIf { GithubPublish publishTask -> publishTask.repositoryName.present }
+        }
     }
 }
diff --git a/src/test/groovy/wooga/gradle/github/GithubPluginSpec.groovy b/src/test/groovy/wooga/gradle/github/GithubPluginSpec.groovy
@@ -92,8 +92,8 @@ class GithubPluginSpec extends ProjectSpec {
         project.plugins.apply(PLUGIN_NAME)
 
         then:
-        def publishTasks = project.tasks.getByName(PublishingPlugin.PUBLISH_LIFECYCLE_TASK_NAME)
-        def githubPublishTask = project.tasks.getByName(GithubPublishPlugin.PUBLISH_TASK_NAME)
+        def githubPublishTask = project.tasks.named(GithubPublishPlugin.PUBLISH_TASK_NAME)
+        def publishTasks = project.tasks.findByName(PublishingPlugin.PUBLISH_LIFECYCLE_TASK_NAME)
         publishTasks.dependsOn.contains(githubPublishTask)
     }
 }