You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tooling.apache.org by sj...@apache.org on 2026/06/02 21:27:04 UTC
(tooling-atr-maven-plugin) branch main updated: Add `@since` annotations for ATR plugin parameters and Mojos
This is an automated email from the ASF dual-hosted git repository.
slawekjaranowski pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-atr-maven-plugin.git
The following commit(s) were added to refs/heads/main by this push:
new 7322f9c Add `@since` annotations for ATR plugin parameters and Mojos
7322f9c is described below
commit 7322f9c4ca224679a7bf6714fdecb436d3c6f1cf
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Wed May 27 20:23:52 2026 +0200
Add `@since` annotations for ATR plugin parameters and Mojos
As we publish documentation after each commit we should be clear which options are added in which version.
---
src/main/java/org/apache/tooling/atr/AbstractAtrMojo.java | 14 ++++++++++++++
.../java/org/apache/tooling/atr/CheckComposingMojo.java | 1 +
src/main/java/org/apache/tooling/atr/UploadMojo.java | 3 +++
3 files changed, 18 insertions(+)
diff --git a/src/main/java/org/apache/tooling/atr/AbstractAtrMojo.java b/src/main/java/org/apache/tooling/atr/AbstractAtrMojo.java
index 3be257e..206f91a 100644
--- a/src/main/java/org/apache/tooling/atr/AbstractAtrMojo.java
+++ b/src/main/java/org/apache/tooling/atr/AbstractAtrMojo.java
@@ -40,30 +40,40 @@ public abstract class AbstractAtrMojo extends AbstractMojo {
/**
* The project key for ATR upload.
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.project", defaultValue = "${project.artifactId}")
protected String project;
/**
* The version for ATR upload.
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.version", defaultValue = "${project.version}")
protected String version;
/**
* The ATR server URL.
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.url", defaultValue = "https://release-test.apache.org/")
protected URL url;
/**
* Skip plugin execution.
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.skip", defaultValue = "false")
protected boolean skip;
/**
* Dry run mode. When enabled, the plugin will simulate execution without performing actual operations.
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.dryRun", defaultValue = "false")
protected boolean dryRun;
@@ -71,6 +81,8 @@ public abstract class AbstractAtrMojo extends AbstractMojo {
/**
* Server ID from settings.xml containing ATR credentials.
* The server's username should be the ASF user ID, and the password should be the Personal Access Token (PAT).
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.serverId", defaultValue = "apache.atr")
protected String serverId;
@@ -78,6 +90,8 @@ public abstract class AbstractAtrMojo extends AbstractMojo {
/**
* If set to true, the plugin will only execute in the execution root directory (typically the top-level
* directory of a multi-module build). This prevents the plugin from running multiple times in child modules.
+ *
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.runOnlyAtExecutionRoot", defaultValue = "false")
protected boolean runOnlyAtExecutionRoot;
diff --git a/src/main/java/org/apache/tooling/atr/CheckComposingMojo.java b/src/main/java/org/apache/tooling/atr/CheckComposingMojo.java
index 61eec43..b602322 100644
--- a/src/main/java/org/apache/tooling/atr/CheckComposingMojo.java
+++ b/src/main/java/org/apache/tooling/atr/CheckComposingMojo.java
@@ -34,6 +34,7 @@ import org.apache.tooling.atr.client.AtrClientFactory;
* Check if a version exists in ATR and is being composed (in draft phase).
*
* @author Maven Team
+ * @since 1.0.0-beta-1
*/
@Mojo(name = "check-composing", defaultPhase = LifecyclePhase.INITIALIZE, threadSafe = true)
public class CheckComposingMojo extends AbstractAtrMojo {
diff --git a/src/main/java/org/apache/tooling/atr/UploadMojo.java b/src/main/java/org/apache/tooling/atr/UploadMojo.java
index 01fa615..f23e559 100644
--- a/src/main/java/org/apache/tooling/atr/UploadMojo.java
+++ b/src/main/java/org/apache/tooling/atr/UploadMojo.java
@@ -36,18 +36,21 @@ import org.codehaus.plexus.util.FileUtils;
* Upload Apache distribution artifacts to ATR (Apache Test Release) compose space before vote.
*
* @author Maven Team
+ * @since 1.0.0-beta-1
*/
@Mojo(name = "upload", defaultPhase = LifecyclePhase.DEPLOY, threadSafe = true)
public class UploadMojo extends AbstractAtrMojo {
/**
* The files to upload to ATR.
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.files", required = true)
private Path[] files;
/**
* The target directory in ATR upload area where files will be uploaded.
+ * @since 1.0.0-beta-1
*/
@Parameter(property = "atr.directory")
private String directory;
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tooling.apache.org
For additional commands, e-mail: commits-help@tooling.apache.org