This is an automated email from the ASF dual-hosted git repository. hboutemy pushed a commit to branch MNG-4840-documentation in repository https://gitbox.apache.org/repos/asf/maven.git
commit 321653b4d7134a8d5125c37f82ec0cea85d0c849 Author: Hervé Boutemy <hbout...@apache.org> AuthorDate: Sat Mar 16 16:02:49 2024 +0100 [MNG-4840] document requiredMavenVersion in plugin descriptor --- .../apache/maven/plugin/descriptor/PluginDescriptor.java | 13 +++++++++++++ maven-plugin-api/src/main/mdo/plugin.mdo | 9 +++++++++ 2 files changed, 22 insertions(+) diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java index e4f5cc4935..85e289bfb5 100644 --- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java +++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java @@ -77,6 +77,7 @@ public class PluginDescriptor extends ComponentSetDescriptor implements Cloneabl private String description; + // MNG-4840 private String requiredMavenVersion; private Plugin plugin; @@ -295,10 +296,22 @@ public class PluginDescriptor extends ComponentSetDescriptor implements Cloneabl return description; } + /** + * Set required Maven version. + * + * @param requiredMavenVersion Maven version required by the plugin + * @since 3.0.2 + */ public void setRequiredMavenVersion(String requiredMavenVersion) { this.requiredMavenVersion = requiredMavenVersion; } + /** + * Get required Maven version. + * + * @return the Maven version required by the plugin + * @since 3.0.2 + */ public String getRequiredMavenVersion() { return requiredMavenVersion; } diff --git a/maven-plugin-api/src/main/mdo/plugin.mdo b/maven-plugin-api/src/main/mdo/plugin.mdo index 5232e6a4ae..4ccc632b3d 100644 --- a/maven-plugin-api/src/main/mdo/plugin.mdo +++ b/maven-plugin-api/src/main/mdo/plugin.mdo @@ -92,6 +92,15 @@ under the License. <type>boolean</type> <defaultValue>true</defaultValue> </field> + <field> + <name>requiredMavenVersion</name> + <version>1.0.0</version> + <description> + Minimum Maven version required to use the plugin. + @since Maven 3.0.2 + </description> + <type>String</type> + </field> <field xdoc.separator="blank"> <name>mojos</name> <version>1.0.0</version>