Added: dev/commons/build-plugin/1.14.0-RC1/site/readme-md-mojo.html ============================================================================== --- dev/commons/build-plugin/1.14.0-RC1/site/readme-md-mojo.html (added) +++ dev/commons/build-plugin/1.14.0-RC1/site/readme-md-mojo.html Fri Apr 12 22:13:13 2024 @@ -0,0 +1,399 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 12 April 2024 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="iso-8859-1" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20240412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Commons Build Plugin – commons-build:readme-md</title> + + <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="./css/site.css" type="text/css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + <script type="text/javascript" src="./js/jquery.min.js"></script> + <script type="text/javascript" src="./js/bootstrap.min.js"></script> + <script type="text/javascript" src="./js/prettify.min.js"></script> + <script type="text/javascript" src="./js/site.js"></script> + + + </head> + + <body class="composite"> + <a href="https://commons.apache.org/"; id="bannerLeft" title="Apache Commons logo"> + <img class="logo-left" src=" ./images/commons-logo.png +" alt="Apache Commons logo"/> + </a> + <div class="clear"></div> + + <div class="navbar"> + <div class="navbar-inner"> + <div class="container-fluid"> + <a class="brand" href="https://commons.apache.org/proper/commons-build-plugin/";>Apache Commons Build Plugin Maven Mojo ™</a> + <ul class="nav"> + + <li id="publishDate">Last Published: 12 April 2024</li> + <li class="divider">|</li> <li id="projectVersion">Version: 1.14.0</li> + </ul> + <div class="pull-right"> <ul class="nav"> + <li> + <a href="https://www.apachecon.com/"; class="externalLink" title="ApacheCon"> + ApacheCon</a> + </li> + <li> + <a href="https://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li> + <a href="../../" title="Commons"> + Commons</a> + </li> + </ul> +</div> + </div> + </div> + </div> + + <div class="container-fluid"> + <table class="layout-table"> + <tr> + <td class="sidebar"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Build Plugin</li> + <li class="none"> + <a href="index.html" title="Overview"> + Overview</a> + </li> + <li class="expanded"> + <a href="" title="Goals"> + Goals</a> + <ul> + <li class="expanded"> + <a href="all.html" title="all"> + all</a> + <ul> + <li class="none"> + <a href="all-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="all-sandbox.html" title="all-sandbox"> + all-sandbox</a> + <ul> + <li class="none"> + <a href="all-sandbox-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="download-page.html" title="download-page"> + download-page</a> + <ul> + <li class="none"> + <a href="download-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="jira-page.html" title="jira-page"> + jira-page</a> + <ul> + <li class="none"> + <a href="jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="sandbox-jira-page.html" title="sandbox-jira-page"> + sandbox-jira-page</a> + <ul> + <li class="none"> + <a href="sandbox-jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="mail-page.html" title="mail-page"> + mail-page</a> + <ul> + <li class="none"> + <a href="mail-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="readme-md.html" title="readme-md"> + readme-md</a> + <ul> + <li class="none active"> + <a href="readme-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="notice-txt.html" title="notice-txt"> + notice-txt</a> + <ul> + <li class="none"> + <a href="notice-txt-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="contributing-md.html" title="contributing-md"> + contributing-md</a> + <ul> + <li class="none"> + <a href="contributing-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="expanded"> + <a href="development.html" title="Help"> + Help</a> + <ul> + <li class="none"> + <a href="issue-tracking.html" title="Issue Tracking"> + Issue Tracking</a> + </li> + <li class="none"> + <a href="development.html" title="Development"> + Development</a> + </li> + <li class="none"> + <a href="https://maven.apache.org/guides/plugin/guide-ant-plugin-development.html"; class="externalLink" title="Maven Plugins"> + Maven Plugins</a> + </li> + <li class="none"> + <a href="https://ant.apache.org/manual/index.html"; class="externalLink" title="Ant"> + Ant</a> + </li> + </ul> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li> + <li class="collapsed"> + <a href="project-info.html" title="Project Information"> + Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html" title="Project Reports"> + Project Reports</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Commons</li> + <li class="none"> + <a href="../../" title="Home"> + Home</a> + </li> + <li class="none"> + <a href="https://www.apache.org/licenses/"; class="externalLink" title="License"> + License</a> + </li> + <li class="collapsed"> + <a href="../../components.html" title="Components"> + Components</a> + </li> + <li class="collapsed"> + <a href="../../sandbox/index.html" title="Sandbox"> + Sandbox</a> + </li> + <li class="collapsed"> + <a href="../../dormant/index.html" title="Dormant"> + Dormant</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">General Information</li> + <li class="none"> + <a href="../../security.html" title="Security"> + Security</a> + </li> + <li class="none"> + <a href="../../volunteering.html" title="Volunteering"> + Volunteering</a> + </li> + <li class="none"> + <a href="../../patches.html" title="Contributing Patches"> + Contributing Patches</a> + </li> + <li class="none"> + <a href="../../building.html" title="Building Components"> + Building Components</a> + </li> + <li class="none"> + <a href="../../commons-parent-pom.html" title="Commons Parent POM"> + Commons Parent POM</a> + </li> + <li class="none"> + <a href="../../build-plugin/index.html" title="Commons Build Plugin"> + Commons Build Plugin</a> + </li> + <li class="none"> + <a href="../../release-plugin/index.html" title="Commons Release Plugin"> + Commons Release Plugin</a> + </li> + <li class="none"> + <a href="../../site-publish.html" title="Site Publication"> + Site Publication</a> + </li> + <li class="none"> + <a href="../../releases/index.html" title="Releasing Components"> + Releasing Components</a> + </li> + <li class="none"> + <a href="https://cwiki.apache.org/confluence/display/commons/FrontPage"; class="externalLink" title="Wiki"> + Wiki</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">ASF</li> + <li class="none"> + <a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How the ASF works"> + How the ASF works</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/getinvolved.html"; class="externalLink" title="Get Involved"> + Get Involved</a> + </li> + <li class="none"> + <a href="https://www.apache.org/dev/"; class="externalLink" title="Developer Resources"> + Developer Resources</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/policies/conduct.html"; class="externalLink" title="Code of Conduct"> + Code of Conduct</a> + </li> + <li class="none"> + <a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Privacy"> + Privacy</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"> + Sponsorship</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + Thanks</a> + </li> + </ul> + </div> + <div id="poweredBy"> + <a href="https://www.apache.org/events/current-event.html"; title="ApacheCon" class="builtBy"> + <img class="builtBy" alt="ApacheCon" src="https://www.apache.org/events/current-event-125x125.png"; /> + </a> + <a href="https://maven.apache.org/"; title="Maven" class="builtBy"> + <img class="builtBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png"; /> + </a> + </div> + </td> + <td class="content"> + <section> +<h2><a name="commons-build:readme-md"></a>commons-build:readme-md</h2><a name="commons-build:readme-md"></a> +<p><strong>Full name</strong>:</p> +<p>org.apache.commons:commons-build-plugin:1.14.0:readme-md</p> +<p><strong>Description</strong>:</p> +<p>Apache Commons Build Mojo: Generate README.md.</p> +<p><strong>Attributes</strong>:</p> +<ul> +<li>Requires a Maven project to be executed.</li> +<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> +<li>Is NOT inherited by default in multi-project builds.</li></ul><section> +<h3><a name="Required_Parameters"></a>Required Parameters</h3><a name="Required_Parameters"></a> +<table border="0" class="bodyTable"> +<tr class="a"> +<th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th></tr> +<tr class="b"> +<td align="left"><a href="#basedir"><code><basedir></code></a></td> +<td><code>File</code></td> +<td><code>-</code></td> +<td>The base directory from which to execute the Ant script.<br /><strong>Default</strong>: <code>${basedir}</code><br /><strong>User Property</strong>: <code>antBasedir</code><br /><strong>Alias</strong>: <code>ant.basedir</code></td></tr> +<tr class="a"> +<td align="left"><a href="#commons.jira.id"><code><commons.jira.id></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The external JIRA id for the project (alphabetic, upper case.)<br /><strong>Default</strong>: <code>${commons.jira.id}</code></td></tr> +<tr class="b"> +<td align="left"><a href="#commons.release.version"><code><commons.release.version></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The version of the latest release of the project.<br /><strong>Default</strong>: <code>${commons.release.version}</code></td></tr></table></section><section> +<h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> +<table border="0" class="bodyTable"> +<tr class="a"> +<th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th></tr> +<tr class="b"> +<td align="left"><a href="#messageLevel"><code><messageLevel></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The message-level used to tune the verbosity of Ant logging.<br /><strong>Default</strong>: <code>info</code><br /><strong>User Property</strong>: <code>antMessageLevel</code><br /><strong>Alias</strong>: <code>ant.messageLevel</code></td></tr></table></section><section> +<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="basedir"><section> +<h4><a name="a.3Cbasedir.3E"></a><basedir></h4><a name="a.3Cbasedir.3E"></a></a> +<div>The base directory from which to execute the Ant script.</div> +<ul> +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>User Property</strong>: <code>antBasedir</code></li> +<li><strong>Default</strong>: <code>${basedir}</code></li> +<li><strong>Alias</strong>: <code>ant.basedir</code></li></ul><hr /></section><a name="commons.jira.id"><section> +<h4><a name="a.3Ccommons.jira.id.3E"></a><commons.jira.id></h4><a name="a.3Ccommons.jira.id.3E"></a></a> +<div>The external JIRA id for the project (alphabetic, upper case.)</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>Default</strong>: <code>${commons.jira.id}</code></li></ul><hr /></section><a name="commons.release.version"><section> +<h4><a name="a.3Ccommons.release.version.3E"></a><commons.release.version></h4><a name="a.3Ccommons.release.version.3E"></a></a> +<div>The version of the latest release of the project.</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>Default</strong>: <code>${commons.release.version}</code></li></ul><hr /></section><a name="messageLevel"><section> +<h4><a name="a.3CmessageLevel.3E"></a><messageLevel></h4><a name="a.3CmessageLevel.3E"></a></a> +<div>The message-level used to tune the verbosity of Ant logging.</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>User Property</strong>: <code>antMessageLevel</code></li> +<li><strong>Default</strong>: <code>info</code></li> +<li><strong>Alias</strong>: <code>ant.messageLevel</code></li></ul></section></section></section> + </td> + </tr> + </table> + </div> + + <div class="footer"> + <p>Copyright © 2008-2024 + <a href="https://www.apache.org/";>The Apache Software Foundation</a>. + All Rights Reserved.</p> + +<div class="center">Apache Commons, Apache Commons Build Plugin Maven Mojo, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. + All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> + </div> + </body> + +</html>
Added: dev/commons/build-plugin/1.14.0-RC1/site/readme-md.html ============================================================================== --- dev/commons/build-plugin/1.14.0-RC1/site/readme-md.html (added) +++ dev/commons/build-plugin/1.14.0-RC1/site/readme-md.html Fri Apr 12 22:13:13 2024 @@ -0,0 +1,404 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 12 April 2024 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="iso-8859-1" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Apache Commons Documentation Team" /> + <meta name="Date-Revision-yyyymmdd" content="20240412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Commons Build Plugin – Generating README.md</title> + + <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="./css/site.css" type="text/css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + <script type="text/javascript" src="./js/jquery.min.js"></script> + <script type="text/javascript" src="./js/bootstrap.min.js"></script> + <script type="text/javascript" src="./js/prettify.min.js"></script> + <script type="text/javascript" src="./js/site.js"></script> + + + </head> + + <body class="composite"> + <a href="https://commons.apache.org/"; id="bannerLeft" title="Apache Commons logo"> + <img class="logo-left" src=" ./images/commons-logo.png +" alt="Apache Commons logo"/> + </a> + <div class="clear"></div> + + <div class="navbar"> + <div class="navbar-inner"> + <div class="container-fluid"> + <a class="brand" href="https://commons.apache.org/proper/commons-build-plugin/";>Apache Commons Build Plugin Maven Mojo ™</a> + <ul class="nav"> + + <li id="publishDate">Last Published: 12 April 2024</li> + <li class="divider">|</li> <li id="projectVersion">Version: 1.14.0</li> + </ul> + <div class="pull-right"> <ul class="nav"> + <li> + <a href="https://www.apachecon.com/"; class="externalLink" title="ApacheCon"> + ApacheCon</a> + </li> + <li> + <a href="https://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li> + <a href="../../" title="Commons"> + Commons</a> + </li> + </ul> +</div> + </div> + </div> + </div> + + <div class="container-fluid"> + <table class="layout-table"> + <tr> + <td class="sidebar"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Build Plugin</li> + <li class="none"> + <a href="index.html" title="Overview"> + Overview</a> + </li> + <li class="expanded"> + <a href="" title="Goals"> + Goals</a> + <ul> + <li class="expanded"> + <a href="all.html" title="all"> + all</a> + <ul> + <li class="none"> + <a href="all-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="all-sandbox.html" title="all-sandbox"> + all-sandbox</a> + <ul> + <li class="none"> + <a href="all-sandbox-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="download-page.html" title="download-page"> + download-page</a> + <ul> + <li class="none"> + <a href="download-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="jira-page.html" title="jira-page"> + jira-page</a> + <ul> + <li class="none"> + <a href="jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="sandbox-jira-page.html" title="sandbox-jira-page"> + sandbox-jira-page</a> + <ul> + <li class="none"> + <a href="sandbox-jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="mail-page.html" title="mail-page"> + mail-page</a> + <ul> + <li class="none"> + <a href="mail-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded active"> + <a href="readme-md.html" title="readme-md"> + readme-md</a> + <ul> + <li class="none"> + <a href="readme-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="notice-txt.html" title="notice-txt"> + notice-txt</a> + <ul> + <li class="none"> + <a href="notice-txt-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="contributing-md.html" title="contributing-md"> + contributing-md</a> + <ul> + <li class="none"> + <a href="contributing-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="expanded"> + <a href="development.html" title="Help"> + Help</a> + <ul> + <li class="none"> + <a href="issue-tracking.html" title="Issue Tracking"> + Issue Tracking</a> + </li> + <li class="none"> + <a href="development.html" title="Development"> + Development</a> + </li> + <li class="none"> + <a href="https://maven.apache.org/guides/plugin/guide-ant-plugin-development.html"; class="externalLink" title="Maven Plugins"> + Maven Plugins</a> + </li> + <li class="none"> + <a href="https://ant.apache.org/manual/index.html"; class="externalLink" title="Ant"> + Ant</a> + </li> + </ul> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li> + <li class="collapsed"> + <a href="project-info.html" title="Project Information"> + Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html" title="Project Reports"> + Project Reports</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Commons</li> + <li class="none"> + <a href="../../" title="Home"> + Home</a> + </li> + <li class="none"> + <a href="https://www.apache.org/licenses/"; class="externalLink" title="License"> + License</a> + </li> + <li class="collapsed"> + <a href="../../components.html" title="Components"> + Components</a> + </li> + <li class="collapsed"> + <a href="../../sandbox/index.html" title="Sandbox"> + Sandbox</a> + </li> + <li class="collapsed"> + <a href="../../dormant/index.html" title="Dormant"> + Dormant</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">General Information</li> + <li class="none"> + <a href="../../security.html" title="Security"> + Security</a> + </li> + <li class="none"> + <a href="../../volunteering.html" title="Volunteering"> + Volunteering</a> + </li> + <li class="none"> + <a href="../../patches.html" title="Contributing Patches"> + Contributing Patches</a> + </li> + <li class="none"> + <a href="../../building.html" title="Building Components"> + Building Components</a> + </li> + <li class="none"> + <a href="../../commons-parent-pom.html" title="Commons Parent POM"> + Commons Parent POM</a> + </li> + <li class="none"> + <a href="../../build-plugin/index.html" title="Commons Build Plugin"> + Commons Build Plugin</a> + </li> + <li class="none"> + <a href="../../release-plugin/index.html" title="Commons Release Plugin"> + Commons Release Plugin</a> + </li> + <li class="none"> + <a href="../../site-publish.html" title="Site Publication"> + Site Publication</a> + </li> + <li class="none"> + <a href="../../releases/index.html" title="Releasing Components"> + Releasing Components</a> + </li> + <li class="none"> + <a href="https://cwiki.apache.org/confluence/display/commons/FrontPage"; class="externalLink" title="Wiki"> + Wiki</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">ASF</li> + <li class="none"> + <a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How the ASF works"> + How the ASF works</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/getinvolved.html"; class="externalLink" title="Get Involved"> + Get Involved</a> + </li> + <li class="none"> + <a href="https://www.apache.org/dev/"; class="externalLink" title="Developer Resources"> + Developer Resources</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/policies/conduct.html"; class="externalLink" title="Code of Conduct"> + Code of Conduct</a> + </li> + <li class="none"> + <a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Privacy"> + Privacy</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"> + Sponsorship</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + Thanks</a> + </li> + </ul> + </div> + <div id="poweredBy"> + <a href="https://www.apache.org/events/current-event.html"; title="ApacheCon" class="builtBy"> + <img class="builtBy" alt="ApacheCon" src="https://www.apache.org/events/current-event-125x125.png"; /> + </a> + <a href="https://maven.apache.org/"; title="Maven" class="builtBy"> + <img class="builtBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png"; /> + </a> + </div> + </td> + <td class="content"> + + + + + + <section> +<h2><a name="commons-build:readme-md"></a>commons-build:readme-md</h2> + + <section> +<h3><a name="Overview"></a>Overview</h3> + +<p> + The <code>commons-build:readme-md</code> goal generates a README.md file for a component. + Execute the goal using the following command: </p> +<div class="source"> +<pre>mvn commons-build:readme-md</pre></div> + + + +<p> + <b>Note:</b> The README.md should be regenerated after every release of the + component since it contains the maven coordinates of the latest release. + </p> + + +<p> + This goal uses the following: + </p> +<ul> + +<li>The goal is mapped to the ant script/target using the <code>readme-md</code> mojo definition in the + <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a> mapping document</li> + +<li>Executes the <code>readme-md</code> target in + <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a> + ant script</li> + +<li>Uses the <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/readme-md-template.md";>readme-md-template.md</a> + template</li> + +<li>Uses the <a href="readme-md-mojo.html">goal's (i.e. mojo's) parameters</a> to filter values in the template</li> + </ul> + + </section> + + <section> +<h3><a name="Configuration"></a>Configuration</h3> + +<p> + To generate a README.md, the following <a href="readme-md-mojo.html">properties</a> are configured in the component's <code>pom.xml</code> + </p> +<ul> + +<li><b>commons.componentid</b> - Commons component ID</li> + +<li><b>commons.jira.id</b> - Commons JIRA ID</li> + +<li><b>commons.release.version</b> - The version number of the latest release of the component</li> + </ul> + + +<p> + Example configuration for Commons Text: +</p> +<div class="source"> +<pre> + <properties> + <commons.componentid>text</commons.componentid> + <commons.release.version>1.10.0</commons.release.version> + </properties> +</pre></div> + + </section> + + </section> + + + + </td> + </tr> + </table> + </div> + + <div class="footer"> + <p>Copyright © 2008-2024 + <a href="https://www.apache.org/";>The Apache Software Foundation</a>. + All Rights Reserved.</p> + +<div class="center">Apache Commons, Apache Commons Build Plugin Maven Mojo, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. + All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> + </div> + </body> + +</html> Added: dev/commons/build-plugin/1.14.0-RC1/site/sandbox-jira-page-mojo.html ============================================================================== --- dev/commons/build-plugin/1.14.0-RC1/site/sandbox-jira-page-mojo.html (added) +++ dev/commons/build-plugin/1.14.0-RC1/site/sandbox-jira-page-mojo.html Fri Apr 12 22:13:13 2024 @@ -0,0 +1,388 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 12 April 2024 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="iso-8859-1" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20240412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Commons Build Plugin – commons-build:sandbox-jira-page</title> + + <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="./css/site.css" type="text/css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + <script type="text/javascript" src="./js/jquery.min.js"></script> + <script type="text/javascript" src="./js/bootstrap.min.js"></script> + <script type="text/javascript" src="./js/prettify.min.js"></script> + <script type="text/javascript" src="./js/site.js"></script> + + + </head> + + <body class="composite"> + <a href="https://commons.apache.org/"; id="bannerLeft" title="Apache Commons logo"> + <img class="logo-left" src=" ./images/commons-logo.png +" alt="Apache Commons logo"/> + </a> + <div class="clear"></div> + + <div class="navbar"> + <div class="navbar-inner"> + <div class="container-fluid"> + <a class="brand" href="https://commons.apache.org/proper/commons-build-plugin/";>Apache Commons Build Plugin Maven Mojo ™</a> + <ul class="nav"> + + <li id="publishDate">Last Published: 12 April 2024</li> + <li class="divider">|</li> <li id="projectVersion">Version: 1.14.0</li> + </ul> + <div class="pull-right"> <ul class="nav"> + <li> + <a href="https://www.apachecon.com/"; class="externalLink" title="ApacheCon"> + ApacheCon</a> + </li> + <li> + <a href="https://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li> + <a href="../../" title="Commons"> + Commons</a> + </li> + </ul> +</div> + </div> + </div> + </div> + + <div class="container-fluid"> + <table class="layout-table"> + <tr> + <td class="sidebar"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Build Plugin</li> + <li class="none"> + <a href="index.html" title="Overview"> + Overview</a> + </li> + <li class="expanded"> + <a href="" title="Goals"> + Goals</a> + <ul> + <li class="expanded"> + <a href="all.html" title="all"> + all</a> + <ul> + <li class="none"> + <a href="all-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="all-sandbox.html" title="all-sandbox"> + all-sandbox</a> + <ul> + <li class="none"> + <a href="all-sandbox-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="download-page.html" title="download-page"> + download-page</a> + <ul> + <li class="none"> + <a href="download-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="jira-page.html" title="jira-page"> + jira-page</a> + <ul> + <li class="none"> + <a href="jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="sandbox-jira-page.html" title="sandbox-jira-page"> + sandbox-jira-page</a> + <ul> + <li class="none active"> + <a href="sandbox-jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="mail-page.html" title="mail-page"> + mail-page</a> + <ul> + <li class="none"> + <a href="mail-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="readme-md.html" title="readme-md"> + readme-md</a> + <ul> + <li class="none"> + <a href="readme-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="notice-txt.html" title="notice-txt"> + notice-txt</a> + <ul> + <li class="none"> + <a href="notice-txt-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="contributing-md.html" title="contributing-md"> + contributing-md</a> + <ul> + <li class="none"> + <a href="contributing-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="expanded"> + <a href="development.html" title="Help"> + Help</a> + <ul> + <li class="none"> + <a href="issue-tracking.html" title="Issue Tracking"> + Issue Tracking</a> + </li> + <li class="none"> + <a href="development.html" title="Development"> + Development</a> + </li> + <li class="none"> + <a href="https://maven.apache.org/guides/plugin/guide-ant-plugin-development.html"; class="externalLink" title="Maven Plugins"> + Maven Plugins</a> + </li> + <li class="none"> + <a href="https://ant.apache.org/manual/index.html"; class="externalLink" title="Ant"> + Ant</a> + </li> + </ul> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li> + <li class="collapsed"> + <a href="project-info.html" title="Project Information"> + Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html" title="Project Reports"> + Project Reports</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Commons</li> + <li class="none"> + <a href="../../" title="Home"> + Home</a> + </li> + <li class="none"> + <a href="https://www.apache.org/licenses/"; class="externalLink" title="License"> + License</a> + </li> + <li class="collapsed"> + <a href="../../components.html" title="Components"> + Components</a> + </li> + <li class="collapsed"> + <a href="../../sandbox/index.html" title="Sandbox"> + Sandbox</a> + </li> + <li class="collapsed"> + <a href="../../dormant/index.html" title="Dormant"> + Dormant</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">General Information</li> + <li class="none"> + <a href="../../security.html" title="Security"> + Security</a> + </li> + <li class="none"> + <a href="../../volunteering.html" title="Volunteering"> + Volunteering</a> + </li> + <li class="none"> + <a href="../../patches.html" title="Contributing Patches"> + Contributing Patches</a> + </li> + <li class="none"> + <a href="../../building.html" title="Building Components"> + Building Components</a> + </li> + <li class="none"> + <a href="../../commons-parent-pom.html" title="Commons Parent POM"> + Commons Parent POM</a> + </li> + <li class="none"> + <a href="../../build-plugin/index.html" title="Commons Build Plugin"> + Commons Build Plugin</a> + </li> + <li class="none"> + <a href="../../release-plugin/index.html" title="Commons Release Plugin"> + Commons Release Plugin</a> + </li> + <li class="none"> + <a href="../../site-publish.html" title="Site Publication"> + Site Publication</a> + </li> + <li class="none"> + <a href="../../releases/index.html" title="Releasing Components"> + Releasing Components</a> + </li> + <li class="none"> + <a href="https://cwiki.apache.org/confluence/display/commons/FrontPage"; class="externalLink" title="Wiki"> + Wiki</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">ASF</li> + <li class="none"> + <a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How the ASF works"> + How the ASF works</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/getinvolved.html"; class="externalLink" title="Get Involved"> + Get Involved</a> + </li> + <li class="none"> + <a href="https://www.apache.org/dev/"; class="externalLink" title="Developer Resources"> + Developer Resources</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/policies/conduct.html"; class="externalLink" title="Code of Conduct"> + Code of Conduct</a> + </li> + <li class="none"> + <a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Privacy"> + Privacy</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"> + Sponsorship</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + Thanks</a> + </li> + </ul> + </div> + <div id="poweredBy"> + <a href="https://www.apache.org/events/current-event.html"; title="ApacheCon" class="builtBy"> + <img class="builtBy" alt="ApacheCon" src="https://www.apache.org/events/current-event-125x125.png"; /> + </a> + <a href="https://maven.apache.org/"; title="Maven" class="builtBy"> + <img class="builtBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png"; /> + </a> + </div> + </td> + <td class="content"> + <section> +<h2><a name="commons-build:sandbox-jira-page"></a>commons-build:sandbox-jira-page</h2><a name="commons-build:sandbox-jira-page"></a> +<p><strong>Full name</strong>:</p> +<p>org.apache.commons:commons-build-plugin:1.14.0:sandbox-jira-page</p> +<p><strong>Description</strong>:</p> +<p>Apache Commons Build Mojo: Generate Sandbox Issue Tracking page.</p> +<p><strong>Attributes</strong>:</p> +<ul> +<li>Requires a Maven project to be executed.</li> +<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li> +<li>Is NOT inherited by default in multi-project builds.</li></ul><section> +<h3><a name="Required_Parameters"></a>Required Parameters</h3><a name="Required_Parameters"></a> +<table border="0" class="bodyTable"> +<tr class="a"> +<th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th></tr> +<tr class="b"> +<td align="left"><a href="#basedir"><code><basedir></code></a></td> +<td><code>File</code></td> +<td><code>-</code></td> +<td>The base directory from which to execute the Ant script.<br /><strong>Default</strong>: <code>${basedir}</code><br /><strong>User Property</strong>: <code>antBasedir</code><br /><strong>Alias</strong>: <code>ant.basedir</code></td></tr> +<tr class="a"> +<td align="left"><a href="#commons.jira.componentid"><code><commons.jira.componentid></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The internal JIRA component id (numeric.)<br /><strong>Default</strong>: <code>${commons.jira.componentid}</code></td></tr></table></section><section> +<h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> +<table border="0" class="bodyTable"> +<tr class="a"> +<th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th></tr> +<tr class="b"> +<td align="left"><a href="#messageLevel"><code><messageLevel></code></a></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The message-level used to tune the verbosity of Ant logging.<br /><strong>Default</strong>: <code>info</code><br /><strong>User Property</strong>: <code>antMessageLevel</code><br /><strong>Alias</strong>: <code>ant.messageLevel</code></td></tr></table></section><section> +<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="basedir"><section> +<h4><a name="a.3Cbasedir.3E"></a><basedir></h4><a name="a.3Cbasedir.3E"></a></a> +<div>The base directory from which to execute the Ant script.</div> +<ul> +<li><strong>Type</strong>: <code>java.io.File</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>User Property</strong>: <code>antBasedir</code></li> +<li><strong>Default</strong>: <code>${basedir}</code></li> +<li><strong>Alias</strong>: <code>ant.basedir</code></li></ul><hr /></section><a name="commons.jira.componentid"><section> +<h4><a name="a.3Ccommons.jira.componentid.3E"></a><commons.jira.componentid></h4><a name="a.3Ccommons.jira.componentid.3E"></a></a> +<div>The internal JIRA component id (numeric.)</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.yes</code></li> +<li><strong>Default</strong>: <code>${commons.jira.componentid}</code></li></ul><hr /></section><a name="messageLevel"><section> +<h4><a name="a.3CmessageLevel.3E"></a><messageLevel></h4><a name="a.3CmessageLevel.3E"></a></a> +<div>The message-level used to tune the verbosity of Ant logging.</div> +<ul> +<li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>report.plugin.goal.no</code></li> +<li><strong>User Property</strong>: <code>antMessageLevel</code></li> +<li><strong>Default</strong>: <code>info</code></li> +<li><strong>Alias</strong>: <code>ant.messageLevel</code></li></ul></section></section></section> + </td> + </tr> + </table> + </div> + + <div class="footer"> + <p>Copyright © 2008-2024 + <a href="https://www.apache.org/";>The Apache Software Foundation</a>. + All Rights Reserved.</p> + +<div class="center">Apache Commons, Apache Commons Build Plugin Maven Mojo, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. + All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> + </div> + </body> + +</html> Added: dev/commons/build-plugin/1.14.0-RC1/site/sandbox-jira-page.html ============================================================================== --- dev/commons/build-plugin/1.14.0-RC1/site/sandbox-jira-page.html (added) +++ dev/commons/build-plugin/1.14.0-RC1/site/sandbox-jira-page.html Fri Apr 12 22:13:13 2024 @@ -0,0 +1,400 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 12 April 2024 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="iso-8859-1" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Apache Commons Documentation Team" /> + <meta name="Date-Revision-yyyymmdd" content="20240412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Commons Build Plugin – Generating Sandbox JIRA Page</title> + + <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="./css/site.css" type="text/css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + <script type="text/javascript" src="./js/jquery.min.js"></script> + <script type="text/javascript" src="./js/bootstrap.min.js"></script> + <script type="text/javascript" src="./js/prettify.min.js"></script> + <script type="text/javascript" src="./js/site.js"></script> + + + </head> + + <body class="composite"> + <a href="https://commons.apache.org/"; id="bannerLeft" title="Apache Commons logo"> + <img class="logo-left" src=" ./images/commons-logo.png +" alt="Apache Commons logo"/> + </a> + <div class="clear"></div> + + <div class="navbar"> + <div class="navbar-inner"> + <div class="container-fluid"> + <a class="brand" href="https://commons.apache.org/proper/commons-build-plugin/";>Apache Commons Build Plugin Maven Mojo ™</a> + <ul class="nav"> + + <li id="publishDate">Last Published: 12 April 2024</li> + <li class="divider">|</li> <li id="projectVersion">Version: 1.14.0</li> + </ul> + <div class="pull-right"> <ul class="nav"> + <li> + <a href="https://www.apachecon.com/"; class="externalLink" title="ApacheCon"> + ApacheCon</a> + </li> + <li> + <a href="https://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li> + <a href="../../" title="Commons"> + Commons</a> + </li> + </ul> +</div> + </div> + </div> + </div> + + <div class="container-fluid"> + <table class="layout-table"> + <tr> + <td class="sidebar"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">Build Plugin</li> + <li class="none"> + <a href="index.html" title="Overview"> + Overview</a> + </li> + <li class="expanded"> + <a href="" title="Goals"> + Goals</a> + <ul> + <li class="expanded"> + <a href="all.html" title="all"> + all</a> + <ul> + <li class="none"> + <a href="all-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="all-sandbox.html" title="all-sandbox"> + all-sandbox</a> + <ul> + <li class="none"> + <a href="all-sandbox-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="download-page.html" title="download-page"> + download-page</a> + <ul> + <li class="none"> + <a href="download-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="jira-page.html" title="jira-page"> + jira-page</a> + <ul> + <li class="none"> + <a href="jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded active"> + <a href="sandbox-jira-page.html" title="sandbox-jira-page"> + sandbox-jira-page</a> + <ul> + <li class="none"> + <a href="sandbox-jira-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="mail-page.html" title="mail-page"> + mail-page</a> + <ul> + <li class="none"> + <a href="mail-page-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="readme-md.html" title="readme-md"> + readme-md</a> + <ul> + <li class="none"> + <a href="readme-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="notice-txt.html" title="notice-txt"> + notice-txt</a> + <ul> + <li class="none"> + <a href="notice-txt-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + <li class="expanded"> + <a href="contributing-md.html" title="contributing-md"> + contributing-md</a> + <ul> + <li class="none"> + <a href="contributing-md-mojo.html" title="properties"> + properties</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="expanded"> + <a href="development.html" title="Help"> + Help</a> + <ul> + <li class="none"> + <a href="issue-tracking.html" title="Issue Tracking"> + Issue Tracking</a> + </li> + <li class="none"> + <a href="development.html" title="Development"> + Development</a> + </li> + <li class="none"> + <a href="https://maven.apache.org/guides/plugin/guide-ant-plugin-development.html"; class="externalLink" title="Maven Plugins"> + Maven Plugins</a> + </li> + <li class="none"> + <a href="https://ant.apache.org/manual/index.html"; class="externalLink" title="Ant"> + Ant</a> + </li> + </ul> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li> + <li class="collapsed"> + <a href="project-info.html" title="Project Information"> + Project Information</a> + </li> + <li class="collapsed"> + <a href="project-reports.html" title="Project Reports"> + Project Reports</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">Commons</li> + <li class="none"> + <a href="../../" title="Home"> + Home</a> + </li> + <li class="none"> + <a href="https://www.apache.org/licenses/"; class="externalLink" title="License"> + License</a> + </li> + <li class="collapsed"> + <a href="../../components.html" title="Components"> + Components</a> + </li> + <li class="collapsed"> + <a href="../../sandbox/index.html" title="Sandbox"> + Sandbox</a> + </li> + <li class="collapsed"> + <a href="../../dormant/index.html" title="Dormant"> + Dormant</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">General Information</li> + <li class="none"> + <a href="../../security.html" title="Security"> + Security</a> + </li> + <li class="none"> + <a href="../../volunteering.html" title="Volunteering"> + Volunteering</a> + </li> + <li class="none"> + <a href="../../patches.html" title="Contributing Patches"> + Contributing Patches</a> + </li> + <li class="none"> + <a href="../../building.html" title="Building Components"> + Building Components</a> + </li> + <li class="none"> + <a href="../../commons-parent-pom.html" title="Commons Parent POM"> + Commons Parent POM</a> + </li> + <li class="none"> + <a href="../../build-plugin/index.html" title="Commons Build Plugin"> + Commons Build Plugin</a> + </li> + <li class="none"> + <a href="../../release-plugin/index.html" title="Commons Release Plugin"> + Commons Release Plugin</a> + </li> + <li class="none"> + <a href="../../site-publish.html" title="Site Publication"> + Site Publication</a> + </li> + <li class="none"> + <a href="../../releases/index.html" title="Releasing Components"> + Releasing Components</a> + </li> + <li class="none"> + <a href="https://cwiki.apache.org/confluence/display/commons/FrontPage"; class="externalLink" title="Wiki"> + Wiki</a> + </li> + </ul> + <ul class="nav nav-list"> + <li class="nav-header">ASF</li> + <li class="none"> + <a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How the ASF works"> + How the ASF works</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/getinvolved.html"; class="externalLink" title="Get Involved"> + Get Involved</a> + </li> + <li class="none"> + <a href="https://www.apache.org/dev/"; class="externalLink" title="Developer Resources"> + Developer Resources</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/policies/conduct.html"; class="externalLink" title="Code of Conduct"> + Code of Conduct</a> + </li> + <li class="none"> + <a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Privacy"> + Privacy</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsorship"> + Sponsorship</a> + </li> + <li class="none"> + <a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + Thanks</a> + </li> + </ul> + </div> + <div id="poweredBy"> + <a href="https://www.apache.org/events/current-event.html"; title="ApacheCon" class="builtBy"> + <img class="builtBy" alt="ApacheCon" src="https://www.apache.org/events/current-event-125x125.png"; /> + </a> + <a href="https://maven.apache.org/"; title="Maven" class="builtBy"> + <img class="builtBy" alt="Maven" src="https://maven.apache.org/images/logos/maven-feather.png"; /> + </a> + </div> + </td> + <td class="content"> + + + + + + <section> +<h2><a name="commons-build:sandbox-jira-page"></a>commons-build:sandbox-jira-page</h2> + + <section> +<h3><a name="Overview"></a>Overview</h3> + +<p> + The <code>commons-build:sandbox-jira-page</code> goal generates a custom JIRA Issue Tracking page for a <b>Sandbox</b> component. + (for <b>Proper</b> components use the <a href="jira-page.html">commons-build:jira-page</a> goal). + Execute the goal using the following command: </p> +<div class="source"> +<pre>mvn commons-build:sandbox-jira-page</pre></div> + + + +<p> + <b>Note:</b> The Issue tracking page should only need to be generated initially + for a component or if the issue tracking template changes. + </p> + + +<p> + This goal uses the following: + </p> +<ul> + +<li>The goal is mapped to the ant script/target using the <code>sandbox-jira-page</code> mojo definition in the + <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a> mapping document</li> + +<li>Executes the <code>sandbox-jira-page</code> target in + <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a> + ant script</li> + +<li>Uses the <a class="externalLink" href="https://gitbox.apache.org/repos/asf?p=commons-build-plugin.git;a=tree;f=src/main/resources/commons-xdoc-templates/sandbox-issue-tracking-template.xml";>sandbox-issue-tracking-template.xml</a> + template</li> + +<li>Uses the <a href="sandbox-jira-page-mojo.html">goal's (i.e. mojo's) parameters</a> to filter values in the template</li> + </ul> + + </section> + + <section> +<h3><a name="Configuration"></a>Configuration</h3> + +<p> + To generate a JIRA page, the following <a href="sandbox-jira-page-mojo.html">properties</a> are configured in the component's <code>pom.xml</code> + </p> +<ul> + +<li><b>commons.jira.componentid</b> - JIRA's internal (numeric) id for the component</li> + </ul> + + +<p> + Example configuration: +</p> +<div class="source"> +<pre> + <properties> + <commons.jira.componentid>12311182</commons.jira.componentid> + </properties> +</pre></div> + + </section> + + </section> + + + + </td> + </tr> + </table> + </div> + + <div class="footer"> + <p>Copyright © 2008-2024 + <a href="https://www.apache.org/";>The Apache Software Foundation</a>. + All Rights Reserved.</p> + +<div class="center">Apache Commons, Apache Commons Build Plugin Maven Mojo, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation. + All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> + </div> + </body> + +</html>
![https://www.apache.org/events/current-event-125x125.png"](https://www.apache.org/events/current-event-125x125.png"){kind=link}
![https://maven.apache.org/images/logos/maven-feather.png"](https://maven.apache.org/images/logos/maven-feather.png"){kind=link}