Swap task descriptions (#37)

Fixes #34
gradlex-org · Jun 7, 2020 · e77c056 · e77c056
1 parent 50b5621
commit e77c056
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/subprojects/documentation/src/docs/asciidoc/parts/release-history.adoc b/subprojects/documentation/src/docs/asciidoc/parts/release-history.adoc
@@ -12,6 +12,7 @@ This fixes problems with up-to-date checking (see {gh-issue}16[#16]).
 
 === Bug fixes
 
+* Task descriptions for help and descriptor task are swapped ({gh-issue}34[#34])
 * Help mojo task is never up to date because descriptor tasks modifies outputs ({gh-issue}16[#16])
 
 === Deprecations

diff --git a/...rc/main/kotlin/de/benediktritter/maven/plugin/development/MavenPluginDevelopmentPlugin.kt b/...rc/main/kotlin/de/benediktritter/maven/plugin/development/MavenPluginDevelopmentPlugin.kt
@@ -46,7 +46,7 @@ class MavenPluginDevelopmentPlugin : Plugin<Project> {
 
         val generateHelpMojoTask = tasks.register<GenerateHelpMojoSourcesTask>("generateMavenPluginHelpMojoSources") {
             group = TASK_GROUP_NAME
-            description = "Generates the Maven plugin descriptor file"
+            description = "Generates a Maven help mojo that documents the usage of the Maven plugin"
 
             onlyIf {
                 if(extension.generateHelpMojo.get()) {
@@ -74,7 +74,7 @@ class MavenPluginDevelopmentPlugin : Plugin<Project> {
         val mojoConfiguration = createConfiguration(project)
         val generateTask = tasks.register<GenerateMavenPluginDescriptorTask>("generateMavenPluginDescriptor") {
             group = TASK_GROUP_NAME
-            description = "Generates a Maven help mojo that documents the usage of the Maven plugin"
+            description = "Generates the Maven plugin descriptor file"
 
             classesDirs.set(extension.pluginSourceSet.map { it.output.classesDirs })
             sourcesDirs.set(extension.pluginSourceSet.map { it.java.sourceDirectories })

diff --git a/.../src/test/groovy/de/benediktritter/maven/plugin/development/BuildLifecycleFuncTest.groovy b/.../src/test/groovy/de/benediktritter/maven/plugin/development/BuildLifecycleFuncTest.groovy
@@ -55,7 +55,7 @@ class BuildLifecycleFuncTest extends AbstractPluginFuncTest {
 
         then:
         result.output.contains("Maven Plugin Development tasks")
-        result.output.contains("generateMavenPluginDescriptor")
-        result.output.contains("generateMavenPluginHelpMojoSources")
+        result.output.contains("generateMavenPluginDescriptor - Generates the Maven plugin descriptor file")
+        result.output.contains("generateMavenPluginHelpMojoSources - Generates a Maven help mojo that documents the usage of the Maven plugin")
     }
 }