Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
220 changes: 220 additions & 0 deletions content/pages/atr/maven/check-composing-mojo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
<!DOCTYPE html>


<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.2:report at 2026-05-24
| Rendered using Apache Maven Fluido Skin 2.1.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>atr:check-composing – Tooling ATR Maven Plugin</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-2.1.0.min.js"></script>
</head>
<body class="topBarEnabled">
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container" style="width: 90%;">
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<nav class="nav-collapse">
<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" />
</a>
<ul class="nav">
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html">Introduction</a></li>
<li class="dropdown-submenu">
<a href="plugin-info.html">Goals</a>
<ul class="dropdown-menu">
<li><a>atr:check-composing</a></li>
<li><a href="upload-mojo.html">atr:upload</a></li>
</ul>
</li>
<li><a href="usage.html">Usage</a></li>
<li><a href="https://www.apache.org/licenses/">License</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html">Project Information</a>
<ul class="dropdown-menu">
<li><a href="ci-management.html">CI Management</a></li>
<li><a href="dependencies.html">Dependencies</a></li>
<li><a href="issue-management.html">Issue Management</a></li>
<li><a href="mailing-lists.html">Mailing Lists</a></li>
<li><a href="plugin-management.html">Plugin Management</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="scm.html">Source Code Management</a></li>
<li><a href="summary.html">Summary</a></li>
<li><a href="team.html">Team</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="plugin-info.html">Plugin Details</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<div class="nav-collapse">
</div>
</div>
</div>
</header>
<div class="container container-top">
<header>
<div id="banner">
<div class="pull-left"></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>

<div id="breadcrumbs">
<ul class="breadcrumb">
<li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li>
<li><a href="https://tooling.apache.org/">Tooling</a><span class="divider">/</span></li>
<li><a href="https://release-test.apache.org/docs/">ATR</a><span class="divider">/</span></li>
<li><a href="./">Maven Plugin</a><span class="divider">/</span></li>
<li class="active">atr:check-composing</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-05-17</li>
<li id="projectVersion" class="pull-right">Version: 1.0.0-beta-1-SNAPSHOT</li>
</ul>
</div>
</header>
<main id="bodyColumn">
<section><a id="atr.3Acheck-composing"></a>
<h1>atr:check-composing</h1>
<p><strong>Full name</strong>:</p>
<p>org.apache.tooling:atr-maven-plugin:1.0.0-beta-1-SNAPSHOT:check-composing</p>
<p><strong>Description</strong>:</p>
<p>Check if a version exists in ATR and is being composed (in draft phase).</p>
<p><strong>Attributes</strong>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>The goal is thread-safe and supports parallel builds.</li>
<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>
<h2>Optional Parameters</h2>
<table class="table table-striped">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th></tr>
<tr class="b">
<td><a href="#dryRun"><code>&lt;dryRun&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<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>
<tr class="a">
<td><a href="#project"><code>&lt;project&gt;</code></a></td>
<td><code>String</code></td>
<td><code>-</code></td>
<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>
<tr class="b">
<td><a href="#runOnlyAtExecutionRoot"><code>&lt;runOnlyAtExecutionRoot&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<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>
<tr class="a">
<td><a href="#serverId"><code>&lt;serverId&gt;</code></a></td>
<td><code>String</code></td>
<td><code>-</code></td>
<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>
<tr class="b">
<td><a href="#skip"><code>&lt;skip&gt;</code></a></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Skip plugin execution.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>atr.skip</code></td></tr>
<tr class="a">
<td><a href="#url"><code>&lt;url&gt;</code></a></td>
<td><code>URL</code></td>
<td><code>-</code></td>
<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>
<tr class="b">
<td><a href="#version"><code>&lt;version&gt;</code></a></td>
<td><code>String</code></td>
<td><code>-</code></td>
<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>
<h2>Parameter Details</h2><a id="dryRun"></a><section><a id="a.3CdryRun.3E"></a>
<h3>&lt;dryRun&gt;</h3>
<div>Dry run mode. When enabled, the plugin will simulate execution without performing actual operations.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.dryRun</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="project"></a><section><a id="a.3Cproject.3E"></a>
<h3>&lt;project&gt;</h3>
<div>The project key for ATR upload.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.project</code></li>
<li><strong>Default</strong>: <code>${project.artifactId}</code></li></ul><hr /></section><a id="runOnlyAtExecutionRoot"></a><section><a id="a.3CrunOnlyAtExecutionRoot.3E"></a>
<h3>&lt;runOnlyAtExecutionRoot&gt;</h3>
<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>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.runOnlyAtExecutionRoot</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="serverId"></a><section><a id="a.3CserverId.3E"></a>
<h3>&lt;serverId&gt;</h3>
<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>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.serverId</code></li>
<li><strong>Default</strong>: <code>apache.atr</code></li></ul><hr /></section><a id="skip"></a><section><a id="a.3Cskip.3E"></a>
<h3>&lt;skip&gt;</h3>
<div>Skip plugin execution.</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.skip</code></li>
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="url"></a><section><a id="a.3Curl.3E"></a>
<h3>&lt;url&gt;</h3>
<div>The ATR server URL.</div>
<ul>
<li><strong>Type</strong>: <code>java.net.URL</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.url</code></li>
<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>
<h3>&lt;version&gt;</h3>
<div>The version for ATR upload.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>User Property</strong>: <code>atr.version</code></li>
<li><strong>Default</strong>: <code>${project.version}</code></li></ul></section></section></section> </main>
</div>
<hr/>
<footer>
<div class="container">
<div class="row">
<p>© 2026
<a href="https://www.apache.org/">The Apache Software Foundation</a>
</p>
</div>
<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>
</p>
</div>
</footer>
<script>
anchors.add();
</script>
</body>
</html>
125 changes: 125 additions & 0 deletions content/pages/atr/maven/ci-management.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<!DOCTYPE html>


<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.9.0:ci-management at 2026-05-24
| Rendered using Apache Maven Fluido Skin 2.1.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>CI Management – Tooling ATR Maven Plugin</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-2.1.0.min.js"></script>
</head>
<body class="topBarEnabled">
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container" style="width: 90%;">
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<nav class="nav-collapse">
<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" />
</a>
<ul class="nav">
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html">Introduction</a></li>
<li class="dropdown-submenu">
<a href="plugin-info.html">Goals</a>
<ul class="dropdown-menu">
<li><a href="check-composing-mojo.html">atr:check-composing</a></li>
<li><a href="upload-mojo.html">atr:upload</a></li>
</ul>
</li>
<li><a href="usage.html">Usage</a></li>
<li><a href="https://www.apache.org/licenses/">License</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html">Project Information</a>
<ul class="dropdown-menu">
<li><a>CI Management</a></li>
<li><a href="dependencies.html">Dependencies</a></li>
<li><a href="issue-management.html">Issue Management</a></li>
<li><a href="mailing-lists.html">Mailing Lists</a></li>
<li><a href="plugin-management.html">Plugin Management</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="scm.html">Source Code Management</a></li>
<li><a href="summary.html">Summary</a></li>
<li><a href="team.html">Team</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="plugin-info.html">Plugin Details</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<div class="nav-collapse">
</div>
</div>
</div>
</header>
<div class="container container-top">
<header>
<div id="banner">
<div class="pull-left"></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>

<div id="breadcrumbs">
<ul class="breadcrumb">
<li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li>
<li><a href="https://tooling.apache.org/">Tooling</a><span class="divider">/</span></li>
<li><a href="https://release-test.apache.org/docs/">ATR</a><span class="divider">/</span></li>
<li><a href="./">Maven Plugin</a><span class="divider">/</span></li>
<li class="active">CI Management</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-05-17</li>
<li id="projectVersion" class="pull-right">Version: 1.0.0-beta-1-SNAPSHOT</li>
</ul>
</div>
</header>
<main id="bodyColumn">
<section><a id="Overview"></a>
<h1>Overview</h1>
<p>This project uses <a class="externalLink" href="https://github.com/features/actions/">GitHub Actions</a>.</p></section><section><a id="Access"></a>
<h1>Access</h1>
<p>The following is a link to the continuous integration system used by the project:</p>
<pre><a class="externalLink" href="https://github.com/apache/tooling-atr-maven-plugin/actions">https://github.com/apache/tooling-atr-maven-plugin/actions</a></pre></section><section><a id="Notifiers"></a>
<h1>Notifiers</h1>
<p>No notifiers are defined. Please check back at a later date.</p></section> </main>
</div>
<hr/>
<footer>
<div class="container">
<div class="row">
<p>© 2026
<a href="https://www.apache.org/">The Apache Software Foundation</a>
</p>
</div>
<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>
</p>
</div>
</footer>
<script>
anchors.add();
</script>
</body>
</html>
20 changes: 20 additions & 0 deletions content/pages/atr/maven/css/apache-maven-fluido-2.1.0.min.css

Large diffs are not rendered by default.

35 changes: 35 additions & 0 deletions content/pages/atr/maven/css/print.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

#banner,
#footer,
#leftcol,
#breadcrumbs,
.docs #toc,
.docs .courtesylinks,
#leftColumn,
#navColumn {
display: none !important;
}

#bodyColumn,
body.docs div.docs {
margin: 0 !important;
border: none !important;
}
Loading
Loading