You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2024/06/08 19:32:31 UTC

(maven-dependency-plugin) 01/01: [MDEP-941] Deprecate dependency:sources in favor of dependency:resolve-sources

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch MDEP-941
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git

commit 4db8ead373d79f37323d69de50e1a3a153f1f378
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sat Jun 8 21:32:05 2024 +0200

    [MDEP-941] Deprecate dependency:sources in favor of dependency:resolve-sources
    
    This closes #411
---
 .../{sources => resolve-sources}/invoker.properties      |  6 +++---
 src/it/projects/{sources => resolve-sources}/pom.xml     |  2 +-
 .../{sources => resolve-sources}/test.properties         |  0
 ...cesMojo.java => OldResolveDependencySourcesMojo.java} | 16 +++++++++-------
 .../resolvers/ResolveDependencySourcesMojo.java          |  4 ++--
 5 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/src/it/projects/sources/invoker.properties b/src/it/projects/resolve-sources/invoker.properties
similarity index 96%
rename from src/it/projects/sources/invoker.properties
rename to src/it/projects/resolve-sources/invoker.properties
index 4c31605a..55dfe7a2 100644
--- a/src/it/projects/sources/invoker.properties
+++ b/src/it/projects/resolve-sources/invoker.properties
@@ -5,9 +5,9 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -15,4 +15,4 @@
 # specific language governing permissions and limitations
 # under the License.
 
-invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:sources
+invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:resolve-sources
diff --git a/src/it/projects/sources/pom.xml b/src/it/projects/resolve-sources/pom.xml
similarity index 97%
rename from src/it/projects/sources/pom.xml
rename to src/it/projects/resolve-sources/pom.xml
index f04fc4d8..1f3f6482 100644
--- a/src/it/projects/sources/pom.xml
+++ b/src/it/projects/resolve-sources/pom.xml
@@ -29,7 +29,7 @@
 
   <name>Test</name>
   <description>
-    Test dependency:sources
+    Test dependency:resolve-sources
   </description>
 
   <properties>
diff --git a/src/it/projects/sources/test.properties b/src/it/projects/resolve-sources/test.properties
similarity index 100%
rename from src/it/projects/sources/test.properties
rename to src/it/projects/resolve-sources/test.properties
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/OldResolveDependencySourcesMojo.java
similarity index 73%
copy from src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
copy to src/main/java/org/apache/maven/plugins/dependency/resolvers/OldResolveDependencySourcesMojo.java
index cc1300e7..03c38efe 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/OldResolveDependencySourcesMojo.java
@@ -18,9 +18,9 @@
  */
 package org.apache.maven.plugins.dependency.resolvers;
 
+import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
-import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 
 /**
@@ -28,18 +28,20 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
  *
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  * @since 2.0-alpha2
+ * @deprecated in favor of {@code resolve-sources} mojo
  */
 @Mojo(
         name = "sources",
         defaultPhase = LifecyclePhase.GENERATE_SOURCES,
         requiresDependencyResolution = ResolutionScope.TEST,
         threadSafe = true)
-public class ResolveDependencySourcesMojo extends ResolveDependenciesMojo {
+@Deprecated
+public class OldResolveDependencySourcesMojo extends ResolveDependencySourcesMojo {
 
-    private static final String SOURCES_CLASSIFIER = "sources";
-
-    @Parameter(name = "classifier", defaultValue = SOURCES_CLASSIFIER, readonly = true)
-    public void setClassifier(String classifier) {
-        this.classifier = classifier;
+    @Override
+    protected void doExecute() throws MojoExecutionException {
+        getLog().warn(
+                        "The goal 'dependency:sources' is deprecated for removal in a future version of this plugin, please use 'dependency:resolve-sources' instead");
+        super.doExecute();
     }
 }
diff --git a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
index cc1300e7..adb87951 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/resolvers/ResolveDependencySourcesMojo.java
@@ -27,10 +27,10 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
  * Goal that resolves the project source dependencies from the repository.
  *
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
- * @since 2.0-alpha2
+ * @since 2.0-alpha2/3.7.0
  */
 @Mojo(
-        name = "sources",
+        name = "resolve-sources",
         defaultPhase = LifecyclePhase.GENERATE_SOURCES,
         requiresDependencyResolution = ResolutionScope.TEST,
         threadSafe = true)