|
| 1 | +<!DOCTYPE html> |
| 2 | + |
| 3 | + |
| 4 | +<!-- |
| 5 | + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.2:report |
| 6 | + | Rendered using Apache Maven Fluido Skin 2.1.0 |
| 7 | +--> |
| 8 | +<html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| 9 | + <head> |
| 10 | + <meta charset="UTF-8" /> |
| 11 | + <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| 12 | + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| 13 | + <title>atr:check-composing – Tooling ATR Maven Plugin</title> |
| 14 | + <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" /> |
| 15 | + <link rel="stylesheet" href="./css/site.css" /> |
| 16 | + <link rel="stylesheet" href="./css/print.css" media="print" /> |
| 17 | + <script src="./js/apache-maven-fluido-2.1.0.min.js"></script> |
| 18 | + </head> |
| 19 | + <body class="topBarEnabled"> |
| 20 | + <header id="topbar" class="navbar navbar-fixed-top "> |
| 21 | + <div class="navbar-inner"> |
| 22 | + <div class="container" style="width: 90%;"> |
| 23 | + <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar"> |
| 24 | + <span class="icon-bar"></span> |
| 25 | + <span class="icon-bar"></span> |
| 26 | + <span class="icon-bar"></span> |
| 27 | + </a> |
| 28 | + <nav class="nav-collapse"> |
| 29 | +<a class="brand" href="https://release-test.apache.org/docs/"><img src="https://release-test.apache.org/static/svg/atr_logo.svg" alt="Apache Tooling ATR Maven Plugin" /> |
| 30 | +</a> |
| 31 | + <ul class="nav"> |
| 32 | + <li class="dropdown"> |
| 33 | + <a class="dropdown-toggle" data-toggle="dropdown">Maven Plugin Overview <b class="caret"></b></a> |
| 34 | + <ul class="dropdown-menu"> |
| 35 | + <li><a href="index.html">Introduction</a></li> |
| 36 | + <li class="dropdown-submenu"> |
| 37 | +<a href="plugin-info.html">Goals</a> |
| 38 | + <ul class="dropdown-menu"> |
| 39 | + <li><a>atr:check-composing</a></li> |
| 40 | + <li><a href="upload-mojo.html">atr:upload</a></li> |
| 41 | + </ul> |
| 42 | + </li> |
| 43 | + <li><a href="usage.html">Usage</a></li> |
| 44 | + <li><a href="https://www.apache.org/licenses/">License</a></li> |
| 45 | + </ul> |
| 46 | + </li> |
| 47 | + <li class="dropdown"> |
| 48 | + <a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a> |
| 49 | + <ul class="dropdown-menu"> |
| 50 | + <li class="dropdown-submenu"> |
| 51 | +<a href="project-info.html">Project Information</a> |
| 52 | + <ul class="dropdown-menu"> |
| 53 | + <li><a href="ci-management.html">CI Management</a></li> |
| 54 | + <li><a href="dependencies.html">Dependencies</a></li> |
| 55 | + <li><a href="issue-management.html">Issue Management</a></li> |
| 56 | + <li><a href="mailing-lists.html">Mailing Lists</a></li> |
| 57 | + <li><a href="plugin-management.html">Plugin Management</a></li> |
| 58 | + <li><a href="plugins.html">Plugins</a></li> |
| 59 | + <li><a href="scm.html">Source Code Management</a></li> |
| 60 | + <li><a href="summary.html">Summary</a></li> |
| 61 | + <li><a href="team.html">Team</a></li> |
| 62 | + </ul> |
| 63 | + </li> |
| 64 | + <li class="dropdown-submenu"> |
| 65 | +<a href="project-reports.html">Project Reports</a> |
| 66 | + <ul class="dropdown-menu"> |
| 67 | + <li><a href="plugin-info.html">Plugin Details</a></li> |
| 68 | + </ul> |
| 69 | + </li> |
| 70 | + </ul> |
| 71 | + </li> |
| 72 | + </ul> |
| 73 | + </nav> |
| 74 | + <div class="nav-collapse"> |
| 75 | + </div> |
| 76 | + </div> |
| 77 | + </div> |
| 78 | + </header> |
| 79 | + <div class="container container-top"> |
| 80 | + <header> |
| 81 | + <div id="banner"> |
| 82 | + <div class="pull-left"></div> |
| 83 | + <div class="pull-right"></div> |
| 84 | + <div class="clear"><hr/></div> |
| 85 | + </div> |
| 86 | + |
| 87 | + <div id="breadcrumbs"> |
| 88 | + <ul class="breadcrumb"> |
| 89 | + <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li> |
| 90 | + <li><a href="https://tooling.apache.org/">Tooling</a><span class="divider">/</span></li> |
| 91 | + <li><a href="https://release-test.apache.org/docs/">ATR</a><span class="divider">/</span></li> |
| 92 | + <li><a href="./">Maven Plugin</a><span class="divider">/</span></li> |
| 93 | + <li class="active">atr:check-composing</li> |
| 94 | + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-05-17</li> |
| 95 | + <li id="projectVersion" class="pull-right">Version: 1.0.0-beta-1-SNAPSHOT</li> |
| 96 | + </ul> |
| 97 | + </div> |
| 98 | + </header> |
| 99 | + <main id="bodyColumn"> |
| 100 | +<section><a id="atr.3Acheck-composing"></a> |
| 101 | +<h1>atr:check-composing</h1> |
| 102 | +<p><strong>Full name</strong>:</p> |
| 103 | +<p>org.apache.tooling:atr-maven-plugin:1.0.0-beta-1-SNAPSHOT:check-composing</p> |
| 104 | +<p><strong>Description</strong>:</p> |
| 105 | +<p>Check if a version exists in ATR and is being composed (in draft phase).</p> |
| 106 | +<p><strong>Attributes</strong>:</p> |
| 107 | +<ul> |
| 108 | +<li>Requires a Maven project to be executed.</li> |
| 109 | +<li>The goal is thread-safe and supports parallel builds.</li> |
| 110 | +<li>Binds by default to the <a class="externalLink" href="https://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>initialize</code>.</li></ul><section><a id="Optional_Parameters"></a> |
| 111 | +<h2>Optional Parameters</h2> |
| 112 | +<table class="table table-striped"> |
| 113 | +<tr class="a"> |
| 114 | +<th>Name</th> |
| 115 | +<th>Type</th> |
| 116 | +<th>Since</th> |
| 117 | +<th>Description</th></tr> |
| 118 | +<tr class="b"> |
| 119 | +<td><a href="#dryRun"><code><dryRun></code></a></td> |
| 120 | +<td><code>boolean</code></td> |
| 121 | +<td><code>-</code></td> |
| 122 | +<td>Dry run mode. When enabled, the plugin will simulate execution without performing actual operations.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>atr.dryRun</code></td></tr> |
| 123 | +<tr class="a"> |
| 124 | +<td><a href="#project"><code><project></code></a></td> |
| 125 | +<td><code>String</code></td> |
| 126 | +<td><code>-</code></td> |
| 127 | +<td>The project key for ATR upload.<br /><strong>Default</strong>: <code>${project.artifactId}</code><br /><strong>User Property</strong>: <code>atr.project</code></td></tr> |
| 128 | +<tr class="b"> |
| 129 | +<td><a href="#runOnlyAtExecutionRoot"><code><runOnlyAtExecutionRoot></code></a></td> |
| 130 | +<td><code>boolean</code></td> |
| 131 | +<td><code>-</code></td> |
| 132 | +<td>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.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>atr.runOnlyAtExecutionRoot</code></td></tr> |
| 133 | +<tr class="a"> |
| 134 | +<td><a href="#serverId"><code><serverId></code></a></td> |
| 135 | +<td><code>String</code></td> |
| 136 | +<td><code>-</code></td> |
| 137 | +<td>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).<br /><strong>Default</strong>: <code>apache.atr</code><br /><strong>User Property</strong>: <code>atr.serverId</code></td></tr> |
| 138 | +<tr class="b"> |
| 139 | +<td><a href="#skip"><code><skip></code></a></td> |
| 140 | +<td><code>boolean</code></td> |
| 141 | +<td><code>-</code></td> |
| 142 | +<td>Skip plugin execution.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>atr.skip</code></td></tr> |
| 143 | +<tr class="a"> |
| 144 | +<td><a href="#url"><code><url></code></a></td> |
| 145 | +<td><code>URL</code></td> |
| 146 | +<td><code>-</code></td> |
| 147 | +<td>The ATR server URL.<br /><strong>Default</strong>: <code>https://release-test.apache.org/</code><br /><strong>User Property</strong>: <code>atr.url</code></td></tr> |
| 148 | +<tr class="b"> |
| 149 | +<td><a href="#version"><code><version></code></a></td> |
| 150 | +<td><code>String</code></td> |
| 151 | +<td><code>-</code></td> |
| 152 | +<td>The version for ATR upload.<br /><strong>Default</strong>: <code>${project.version}</code><br /><strong>User Property</strong>: <code>atr.version</code></td></tr></table></section><section><a id="Parameter_Details"></a> |
| 153 | +<h2>Parameter Details</h2><a id="dryRun"></a><section><a id="a.3CdryRun.3E"></a> |
| 154 | +<h3><dryRun></h3> |
| 155 | +<div>Dry run mode. When enabled, the plugin will simulate execution without performing actual operations.</div> |
| 156 | +<ul> |
| 157 | +<li><strong>Type</strong>: <code>boolean</code></li> |
| 158 | +<li><strong>Required</strong>: <code>No</code></li> |
| 159 | +<li><strong>User Property</strong>: <code>atr.dryRun</code></li> |
| 160 | +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="project"></a><section><a id="a.3Cproject.3E"></a> |
| 161 | +<h3><project></h3> |
| 162 | +<div>The project key for ATR upload.</div> |
| 163 | +<ul> |
| 164 | +<li><strong>Type</strong>: <code>java.lang.String</code></li> |
| 165 | +<li><strong>Required</strong>: <code>No</code></li> |
| 166 | +<li><strong>User Property</strong>: <code>atr.project</code></li> |
| 167 | +<li><strong>Default</strong>: <code>${project.artifactId}</code></li></ul><hr /></section><a id="runOnlyAtExecutionRoot"></a><section><a id="a.3CrunOnlyAtExecutionRoot.3E"></a> |
| 168 | +<h3><runOnlyAtExecutionRoot></h3> |
| 169 | +<div>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.</div> |
| 170 | +<ul> |
| 171 | +<li><strong>Type</strong>: <code>boolean</code></li> |
| 172 | +<li><strong>Required</strong>: <code>No</code></li> |
| 173 | +<li><strong>User Property</strong>: <code>atr.runOnlyAtExecutionRoot</code></li> |
| 174 | +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="serverId"></a><section><a id="a.3CserverId.3E"></a> |
| 175 | +<h3><serverId></h3> |
| 176 | +<div>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).</div> |
| 177 | +<ul> |
| 178 | +<li><strong>Type</strong>: <code>java.lang.String</code></li> |
| 179 | +<li><strong>Required</strong>: <code>No</code></li> |
| 180 | +<li><strong>User Property</strong>: <code>atr.serverId</code></li> |
| 181 | +<li><strong>Default</strong>: <code>apache.atr</code></li></ul><hr /></section><a id="skip"></a><section><a id="a.3Cskip.3E"></a> |
| 182 | +<h3><skip></h3> |
| 183 | +<div>Skip plugin execution.</div> |
| 184 | +<ul> |
| 185 | +<li><strong>Type</strong>: <code>boolean</code></li> |
| 186 | +<li><strong>Required</strong>: <code>No</code></li> |
| 187 | +<li><strong>User Property</strong>: <code>atr.skip</code></li> |
| 188 | +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="url"></a><section><a id="a.3Curl.3E"></a> |
| 189 | +<h3><url></h3> |
| 190 | +<div>The ATR server URL.</div> |
| 191 | +<ul> |
| 192 | +<li><strong>Type</strong>: <code>java.net.URL</code></li> |
| 193 | +<li><strong>Required</strong>: <code>No</code></li> |
| 194 | +<li><strong>User Property</strong>: <code>atr.url</code></li> |
| 195 | +<li><strong>Default</strong>: <code>https://release-test.apache.org/</code></li></ul><hr /></section><a id="version"></a><section><a id="a.3Cversion.3E"></a> |
| 196 | +<h3><version></h3> |
| 197 | +<div>The version for ATR upload.</div> |
| 198 | +<ul> |
| 199 | +<li><strong>Type</strong>: <code>java.lang.String</code></li> |
| 200 | +<li><strong>Required</strong>: <code>No</code></li> |
| 201 | +<li><strong>User Property</strong>: <code>atr.version</code></li> |
| 202 | +<li><strong>Default</strong>: <code>${project.version}</code></li></ul></section></section></section> </main> |
| 203 | + </div> |
| 204 | + <hr/> |
| 205 | + <footer> |
| 206 | + <div class="container"> |
| 207 | + <div class="row"> |
| 208 | + <p>© 2026 |
| 209 | +<a href="https://www.apache.org/">The Apache Software Foundation</a> |
| 210 | +</p> |
| 211 | + </div> |
| 212 | + <p id="poweredBy" class="pull-right"><a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| 213 | +</p> |
| 214 | + </div> |
| 215 | + </footer> |
| 216 | + <script> |
| 217 | + anchors.add(); |
| 218 | + </script> |
| 219 | + </body> |
| 220 | +</html> |
0 commit comments