You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sj...@apache.org on 2023/12/28 10:11:23 UTC
(maven-site) branch plugin-tools-improvements created (now af8adaf0)
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a change to branch plugin-tools-improvements
in repository https://gitbox.apache.org/repos/asf/maven-site.git
at af8adaf0 Improve documentation about plugin-tools
This branch includes the following new commits:
new af8adaf0 Improve documentation about plugin-tools
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven-site) 01/01: Improve documentation about plugin-tools
Posted by sj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch plugin-tools-improvements
in repository https://gitbox.apache.org/repos/asf/maven-site.git
commit af8adaf0c3ad34c098b5bae4fa3fe8c2859ae947
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Thu Dec 28 11:11:05 2023 +0100
Improve documentation about plugin-tools
---
...entation.apt => guide-plugin-documentation.apt.vm} | 19 ++++++++-----------
...t => introduction-to-plugin-prefix-mapping.apt.vm} | 2 +-
...pt => guide-java-report-plugin-development.apt.vm} | 12 ++++--------
3 files changed, 13 insertions(+), 20 deletions(-)
diff --git a/content/apt/guides/development/guide-plugin-documentation.apt b/content/apt/guides/development/guide-plugin-documentation.apt.vm
similarity index 96%
rename from content/apt/guides/development/guide-plugin-documentation.apt
rename to content/apt/guides/development/guide-plugin-documentation.apt.vm
index 3a7f4cae..eef584eb 100644
--- a/content/apt/guides/development/guide-plugin-documentation.apt
+++ b/content/apt/guides/development/guide-plugin-documentation.apt.vm
@@ -164,8 +164,8 @@ mvn site
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-plugin-plugin</artifactId>
- <version>2.5.1</version>
+ <artifactId>maven-plugin-report-plugin</artifactId>
+ <version>$context.get("version.maven-plugin-tools")</version>
</plugin>
</plugins>
</reporting>
@@ -177,15 +177,14 @@ mvn site
names are extracted from the plugin source and rendered in the Plugin Info page. In order for the generated site to
be useful here are some guidelines you can follow when documenting your plugin.
- * all <<<...@parameter>>> fields should have a descriptive comment, informative enough that even a regular user can understand
+ * all <<<...@Parameter>>> fields should have a descriptive comment, informative enough that even a regular user can understand
+--------------+
[...]
/**
* Put something informative here that a regular user can understand.
- *
- * @parameter
*/
+ @Parameter
private boolean someparameter;
[...]
+--------------+
@@ -196,10 +195,8 @@ mvn site
[...]
/**
* Everything here will show up on the top of the generated plugin info page.
- *
- * @goal somegoal
- * @phase compile
*/
+@Mojo(name = "somegoal", defaultPhase = LifecyclePhase.COMPILE)
public class ExampleMojo
extends AbstractWarMojo
{
@@ -209,7 +206,7 @@ public class ExampleMojo
[...]
+--------------+
- * the <<<...@component>>> and <<<...@readonly>>> parameters are not required to have any comments but it's still a good practice to provide one
+ * the <<<...@Component>>> and <<<readonly>>> parameters are not required to have any comments but it's still a good practice to provide one
*Site Organization
@@ -364,7 +361,7 @@ Plugin Name
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.4</version>
+ <version>$context.get("version.maven-javadoc-plugin")</version>
<configuration>
<minmemory>128m</minmemory>
<maxmemory>512</maxmemory>
@@ -399,7 +396,7 @@ Plugin Name
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
- <version>2.1</version>
+ <version>3.3.1</version>
</plugin>
</plugins>
</reporting>
diff --git a/content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt b/content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt.vm
similarity index 98%
rename from content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt
rename to content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt.vm
index 3980eb45..a0ca0a55 100644
--- a/content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt
+++ b/content/apt/guides/introduction/introduction-to-plugin-prefix-mapping.apt.vm
@@ -74,7 +74,7 @@ Introduction to Plugin Prefix Resolution
...
<plugin>
<artifactId>maven-plugin-plugin</artifactId>
- <version>2.3</version>
+ <version>$context.get("version.maven-plugin-tools")</version>
<configuration>
...
<goalPrefix>somePrefix</goalPrefix>
diff --git a/content/apt/guides/plugin/guide-java-report-plugin-development.apt b/content/apt/guides/plugin/guide-java-report-plugin-development.apt.vm
similarity index 98%
rename from content/apt/guides/plugin/guide-java-report-plugin-development.apt
rename to content/apt/guides/plugin/guide-java-report-plugin-development.apt.vm
index 7f0f558f..ab5a238b 100644
--- a/content/apt/guides/plugin/guide-java-report-plugin-development.apt
+++ b/content/apt/guides/plugin/guide-java-report-plugin-development.apt.vm
@@ -198,7 +198,7 @@ Introduction
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
- <version>3.5</version>
+ <version>$context.get("version.maven-plugin-tools")</version>
<scope>provided</scope>
</dependency>
<dependency>
@@ -214,24 +214,20 @@ Introduction
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
- <version>3.7.0</version>
+ <version>$context.get("version.maven-compiler-plugin")</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
- <version>2.5.2</version>
+ <version>$context.get("version.maven-install-plugin")</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
- <version>3.5.1</version>
+ <version>$context.get("version.maven-plugin-tools")</version>
<configuration>
<goalPrefix>simple</goalPrefix>
</configuration>
<executions>
- <execution>
- <id>default-descriptor</id>
- <phase>process-classes</phase>
- </execution>
<execution>
<id>generated-helpmojo</id>
<goals>