atr:check-composing

Full name:

org.apache.tooling:atr-maven-plugin:1.0.0-beta-1-SNAPSHOT:check-composing

Description:

Check if a version exists in ATR and is being composed (in draft phase).

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: initialize.

Optional Parameters

Name Type Since Description
<dryRun> boolean - Dry run mode. When enabled, the plugin will simulate execution without performing actual operations.
Default: false
User Property: atr.dryRun
<project> String - The project key for ATR upload.
Default: ${project.artifactId}
User Property: atr.project
<runOnlyAtExecutionRoot> boolean - 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.
Default: false
User Property: atr.runOnlyAtExecutionRoot
<serverId> String - 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).
Default: apache.atr
User Property: atr.serverId
<skip> boolean - Skip plugin execution.
Default: false
User Property: atr.skip
<url> URL - The ATR server URL.
Default: https://release-test.apache.org/
User Property: atr.url
<version> String - The version for ATR upload.
Default: ${project.version}
User Property: atr.version

Parameter Details

<dryRun>

Dry run mode. When enabled, the plugin will simulate execution without performing actual operations.
  • Type: boolean
  • Required: No
  • User Property: atr.dryRun
  • Default: false

<project>

The project key for ATR upload.
  • Type: java.lang.String
  • Required: No
  • User Property: atr.project
  • Default: ${project.artifactId}

<runOnlyAtExecutionRoot>

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.
  • Type: boolean
  • Required: No
  • User Property: atr.runOnlyAtExecutionRoot
  • Default: false

<serverId>

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).
  • Type: java.lang.String
  • Required: No
  • User Property: atr.serverId
  • Default: apache.atr

<skip>

Skip plugin execution.
  • Type: boolean
  • Required: No
  • User Property: atr.skip
  • Default: false

<url>

The ATR server URL.
  • Type: java.net.URL
  • Required: No
  • User Property: atr.url
  • Default: https://release-test.apache.org/

<version>

The version for ATR upload.
  • Type: java.lang.String
  • Required: No
  • User Property: atr.version
  • Default: ${project.version}