blob: 86173ca1b69b0cacca706fee22c2dffc063f097a [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<!--
$HeadURL$
$Revision$ $Date$
-->
<document>
<properties>
<title>Overview</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
<section name="Build Plugin">
<p>
This is a <a href="http://maven.apache.org/">Maven 2.x</a>
<a href="http://ant.apache.org/">Ant</a> Plugin which is
used by <a href="http://commons.apache.org/">Apache Commons</a> builds. See
the <a href="development.html">Development</a> page for information to
help maintain this plugin.
</p>
</section>
<section name="Plugin Goals">
<p>
Available Goals:
<ul>
<li><a href="download-page.html">commons:download-page</a> - Generate a Download page for the component's latest release</li>
<li><a href="jira-page.html">commons:jira-page</a> - Generate a custom JIRA Issue Tracking page for a component</li>
<li><a href="sandbox-jira-page.html">commons:sandbox-jira-page</a> - Generate a custom JIRA Issue Tracking page for a Sandbox component</li>
<li><a href="copy-javadoc-files-build.html">commons:copy-javadoc-files</a> - Copy NOTICE and LICENSE files to -javadoc jar</li>
</ul>
</p>
</section>
<section name="Trying out the plugin">
<p>
Configure the plugin in the <code>&lt;build&gt;</code> section of the <code>pom.xml</code>
<source><![CDATA[
<plugin>
<groupId>org.apache.commons</groupId>
<artifactId>commons-build-plugin</artifactId>
<version>1.2</version>
</plugin>
]]></source>
</p>
<p>
Configure any properties required by the goal and try exectuing.
</p>
</section>
</body>
</document>