Repository: commons-build-plugin Updated Branches: refs/heads/master 2faf19365 -> eab5d47e2
Allow for use with Sanbox components. Project: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/commit/eab5d47e Tree: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/tree/eab5d47e Diff: http://git-wip-us.apache.org/repos/asf/commons-build-plugin/diff/eab5d47e Branch: refs/heads/master Commit: eab5d47e23b56fb18fa7b7b8856141ca950334d3 Parents: 2faf193 Author: Gary Gregory <garydgreg...@gmail.com> Authored: Tue May 15 17:24:43 2018 -0600 Committer: Gary Gregory <garydgreg...@gmail.com> Committed: Tue May 15 17:24:43 2018 -0600 ---------------------------------------------------------------------- src/main/scripts/generate-xdocs.build.xml | 2 +- src/main/scripts/generate-xdocs.mojos.xml | 247 ++++++++++++++++++++++++- src/site/site.xml | 5 +- src/site/xdoc/all-mojo-sandbox.xml | 44 +++++ src/site/xdoc/all-sandbox.xml | 57 ++++++ src/site/xdoc/all.xml | 2 +- src/site/xdoc/index.xml | 19 +- 7 files changed, 363 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/main/scripts/generate-xdocs.build.xml ---------------------------------------------------------------------- diff --git a/src/main/scripts/generate-xdocs.build.xml b/src/main/scripts/generate-xdocs.build.xml index 2275f33..ee549cb 100644 --- a/src/main/scripts/generate-xdocs.build.xml +++ b/src/main/scripts/generate-xdocs.build.xml @@ -27,7 +27,7 @@ <!-- ========== Generate All Pages ================================ --> <target name="all" description="Generate all pages" depends="contributing-md, download-page, jira-page, mail-page, readme-md" /> - <target name="all-sandbox" description="Generate all pages" depends="contributing-md, download-page, sandbox-jira-page, mail-page, readme-md" /> + <target name="all-sandbox" description="Generate all sandbox pages" depends="contributing-md, download-page, sandbox-jira-page, mail-page, readme-md" /> <!-- ========== Generate Mailing List Page ================================ --> http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/main/scripts/generate-xdocs.mojos.xml ---------------------------------------------------------------------- diff --git a/src/main/scripts/generate-xdocs.mojos.xml b/src/main/scripts/generate-xdocs.mojos.xml index a39766d..fa80917 100644 --- a/src/main/scripts/generate-xdocs.mojos.xml +++ b/src/main/scripts/generate-xdocs.mojos.xml @@ -25,7 +25,252 @@ <mojo> <goal>all</goal> <call>all</call> - <description>Apache Commons Build Mojo: Generate Mailing List page.</description> + <description>Apache Commons Build Mojo: Generate all pages.</description> + <requiresProject>true</requiresProject> + <parameters> + <parameter> + <name>project.name</name> + <property>project.name</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${project.name}</defaultValue> + <type>java.lang.String</type> + <description>The name of the project currently being built.</description> + </parameter> + <parameter> + <name>project.groupId</name> + <property>project.groupId</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${project.groupId}</defaultValue> + <type>java.lang.String</type> + <description>The groupId of the project currently being built.</description> + </parameter> + <parameter> + <name>project.artifactId</name> + <property>project.artifactId</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${project.artifactId}</defaultValue> + <type>java.lang.String</type> + <description>The artifactId of the project currently being built.</description> + </parameter> + <parameter> + <name>commons.jira.id</name> + <property>commons.jira.id</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.jira.id}</defaultValue> + <type>java.lang.String</type> + <description>The external JIRA id for the project (alphabetic, upper case.)</description> + </parameter> + <parameter> + <name>commons.componentid</name> + <property>commons.componentid</property> + <required>true</required> + <readonly>true</readonly> + <defaultValue>${commons.componentid}</defaultValue> + <type>java.lang.String</type> + <description>The commons component id.</description> + </parameter> + <parameter> + <name>commons.jira.pid</name> + <property>commons.jira.pid</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.jira.pid}</defaultValue> + <type>java.lang.String</type> + <description>The internal JIRA id for the project (numeric.)</description> + </parameter> + <parameter> + <name>commons.release.version</name> + <property>commons.release.version</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of the latest release of the project.</description> + </parameter> + <parameter> + <name>commons.release.name</name> + <property>commons.release.name</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.name}</defaultValue> + <type>java.lang.String</type> + <description>The name of the latest release of the project.</description> + </parameter> + <parameter> + <name>commons.binary.suffix</name> + <property>commons.binary.suffix</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.binary.suffix}</defaultValue> + <type>java.lang.String</type> + <description>The suffix for the binary distribution.</description> + </parameter> + <parameter> + <name>commons.release.desc</name> + <property>commons.release.desc</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.desc}</defaultValue> + <type>java.lang.String</type> + <description>Release Title or Description.</description> + </parameter> + <parameter> + <name>commons.release.subdir</name> + <property>commons.release.subdir</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.subdir}</defaultValue> + <type>java.lang.String</type> + <description>Subdirectory (instead of source/binaries.)</description> + </parameter> + <!-- commons.release.2.* --> + <parameter> + <name>commons.release.2.version</name> + <property>commons.release.2.version</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.2.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of an alternative release of the project.</description> + </parameter> + <parameter> + <name>commons.release.2.name</name> + <property>commons.release.2.name</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.2.name}</defaultValue> + <type>java.lang.String</type> + <description>The name of the alternative release of the project.</description> + </parameter> + <parameter> + <name>commons.release.2.desc</name> + <property>commons.release.2.desc</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.2.desc}</defaultValue> + <type>java.lang.String</type> + <description>Alternative Release Title or Description.</description> + </parameter> + <parameter> + <name>commons.release.2.binary.suffix</name> + <property>commons.release.2.binary.suffix</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.2.binary.suffix}</defaultValue> + <type>java.lang.String</type> + <description>The suffix for the alternative release binary distribution.</description> + </parameter> + <parameter> + <name>commons.release.2.subdir</name> + <property>commons.release.2.subdir</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.2.subdir}</defaultValue> + <type>java.lang.String</type> + <description>Subdirectory (instead of source/binaries.)</description> + </parameter> + <!-- commons.release.3.* --> + <parameter> + <name>commons.release.3.version</name> + <property>commons.release.3.version</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.3.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of an alternative release of the project.</description> + </parameter> + <parameter> + <name>commons.release.3.name</name> + <property>commons.release.3.name</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.3.name}</defaultValue> + <type>java.lang.String</type> + <description>The name of the alternative release of the project.</description> + </parameter> + <parameter> + <name>commons.release.3.desc</name> + <property>commons.release.3.desc</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.3.desc}</defaultValue> + <type>java.lang.String</type> + <description>Alternative Release Title or Description.</description> + </parameter> + <parameter> + <name>commons.release.3.binary.suffix</name> + <property>commons.release.3.binary.suffix</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.3.binary.suffix}</defaultValue> + <type>java.lang.String</type> + <description>The suffix for the alternative release binary distribution.</description> + </parameter> + <parameter> + <name>commons.release.3.subdir</name> + <property>commons.release.3.subdir</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.3.subdir}</defaultValue> + <type>java.lang.String</type> + <description>Subdirectory (instead of source/binaries.)</description> + </parameter> + <!-- commons.release.4.* --> + <parameter> + <name>commons.release.4.version</name> + <property>commons.release.4.version</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.4.version}</defaultValue> + <type>java.lang.String</type> + <description>The version of an alternative release of the project.</description> + </parameter> + <parameter> + <name>commons.release.4.name</name> + <property>commons.release.4.name</property> + <required>true</required> + <readonly>false</readonly> + <defaultValue>${commons.release.4.name}</defaultValue> + <type>java.lang.String</type> + <description>The name of the alternative release of the project.</description> + </parameter> + <parameter> + <name>commons.release.4.desc</name> + <property>commons.release.4.desc</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.4.desc}</defaultValue> + <type>java.lang.String</type> + <description>Alternative Release Title or Description.</description> + </parameter> + <parameter> + <name>commons.release.4.binary.suffix</name> + <property>commons.release.4.binary.suffix</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.4.binary.suffix}</defaultValue> + <type>java.lang.String</type> + <description>The suffix for the alternative release binary distribution.</description> + </parameter> + <parameter> + <name>commons.release.4.subdir</name> + <property>commons.release.4.subdir</property> + <required>false</required> + <readonly>false</readonly> + <defaultValue>${commons.release.4.subdir}</defaultValue> + <type>java.lang.String</type> + <description>Subdirectory (instead of source/binaries.)</description> + </parameter> + </parameters> + </mojo> + <mojo> + <goal>all-sandbox</goal> + <call>all-sandbox</call> + <description>Apache Commons Build Mojo: Generate all sandbox pages.</description> <requiresProject>true</requiresProject> <parameters> <parameter> http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 7e58a0f..4f3bcae 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -21,9 +21,12 @@ <menu name="Build Plugin"> <item name="Overview" href="/index.html"/> <item name="Goals"> - <item name="all" href="/all.html"> + <item name="all" href="/all.html"> <item name="properties" href="/all-mojo.html"/> </item> + <item name="all-sandbox" href="/all-sandbox.html"> + <item name="properties" href="/all-sandbox-mojo.html"/> + </item> <item name="download-page" href="/download-page.html"> <item name="properties" href="/download-page-mojo.html"/> </item> http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/site/xdoc/all-mojo-sandbox.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/all-mojo-sandbox.xml b/src/site/xdoc/all-mojo-sandbox.xml new file mode 100644 index 0000000..02c3210 --- /dev/null +++ b/src/site/xdoc/all-mojo-sandbox.xml @@ -0,0 +1,44 @@ +<?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. +--> +<document> + <properties> + <title>commons:all</title> + </properties> + <body> + <section name="commons:all-sandbox"> + <p><strong>Full name</strong>:</p> + <p>org.apache.commons:commons-build-plugin:1.9:all-sandbox</p> + <p><strong>Description</strong>:</p> + <div>Apache Commons Build Mojo: Generate all sandbox pages</div> + <p><strong>Attributes</strong>:</p> + <ul> + <li>Requires a Maven 2.0 project to be executed.</li> + <li>Is NOT inherited by default in multi-project builds.</li> + </ul> + <subsection name="Required Parameters"> + <p>This is the union of all parameters for all goals in this plugin.</p> + </subsection> + <subsection name="Optional Parameters"> + <p>This is the union of all parameters for all goals in this plugin.</p> + </subsection> + <subsection name="Parameter Details"> + <p>This is the union of all parameters for all goals in this plugin.</p> + </subsection> + </section> + </body> +</document> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/site/xdoc/all-sandbox.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/all-sandbox.xml b/src/site/xdoc/all-sandbox.xml new file mode 100644 index 0000000..08e2770 --- /dev/null +++ b/src/site/xdoc/all-sandbox.xml @@ -0,0 +1,57 @@ +<?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. +--> +<document> + + <properties> + <title>Generating All Sandbox Pages</title> + <author email="d...@commons.apache.org">Apache Commons Documentation Team</author> + </properties> + + <body> + + + <section name="commons:all-sandbox" href="all-sandbox"> + + <subsection name="Overview"> + <p> + The <code>commons:all-sandbox</code> goal generates all pages for a <strong>Sandbox</strong> component + (for <strong>Proper</strong> components use the <a href="all.html">commons:all</a> goal). + Execute the goal using the following command: <source>mvn commons:all-sandbox</source> + </p> + <p> + This goal uses the following: + <ul> + <li>The goal is mapped to the ant script/target using the <code>all-sandbox</code> Mojo defintion in the + <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml";>generate-xdocs.mojos.xml</a> mapping document</li> + <li>Executes the <code>all-sandbox</code> target in + <a href="http://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml";>generate-xdocs.build.xml</a> + ant script</li> + </ul> + </p> + </subsection> + + <subsection name="Configuration"> + <p> + To generate all pages, the union of other goal's properties are configured in the component's <code>pom.xml</code> + </p> + </subsection> + + </section> + + </body> +</document> http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/site/xdoc/all.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/all.xml b/src/site/xdoc/all.xml index 96275ad..bf336a5 100644 --- a/src/site/xdoc/all.xml +++ b/src/site/xdoc/all.xml @@ -30,7 +30,7 @@ <subsection name="Overview"> <p> The <code>commons:all</code> goal generates all pages for a <strong>Proper</strong> component - (for <strong>Sandbox</strong> components use the <a href="sandbox-all.html">commons:sandbox-all</a> goal). + (for <strong>Sandbox</strong> components use the <a href="all-sandbox.html">commons:all-sandbox</a> goal). Execute the goal using the following command: <source>mvn commons:all</source> </p> <p> http://git-wip-us.apache.org/repos/asf/commons-build-plugin/blob/eab5d47e/src/site/xdoc/index.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 4284490..b93f7c6 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -40,14 +40,15 @@ <p> Available Goals: <ul> - <li><a href="all.html">commons:all</a> - Generate all pages for the component's latest release</li> - <li><a href="download-page.html">commons:download-page</a> - Generate a Download page for the component's latest release</li> - <li><a href="mail-page.html">commons:mail-page</a> - Generate a custom <i>Mailing List</i> page for a component</li> - <li><a href="jira-page.html">commons:jira-page</a> - Generate a custom <i>JIRA Issue Tracking</i> page for a component</li> - <li><a href="sandbox-jira-page.html">commons:sandbox-jira-page</a> - Generate a custom <i>JIRA Issue Tracking page</i> 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> - <li><a href="readme-md.html">commons:readme-md</a> - Generate a README.md file containing information for contributors from GitHub</li> - <li><a href="contributing-md.html">commons:contributing-md</a> - Generate a CONTRIBUTING.md file containing information on how to contribute for contributors from GitHub</li> + <li><a href="all.html">commons:all</a> - Generate all pages for the component's latest release (but not sandbox pages.)</li> + <li><a href="all-sandbox.html">commons:all-sandbox</a> - Generate all pages for the sandbox component's latest release.</li> + <li><a href="download-page.html">commons:download-page</a> - Generate a Download page for the component's latest release.</li> + <li><a href="mail-page.html">commons:mail-page</a> - Generate a custom <i>Mailing List</i> page for a component.</li> + <li><a href="jira-page.html">commons:jira-page</a> - Generate a custom <i>JIRA Issue Tracking</i> page for a component.</li> + <li><a href="sandbox-jira-page.html">commons:sandbox-jira-page</a> - Generate a custom <i>JIRA Issue Tracking page</i> 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> + <li><a href="readme-md.html">commons:readme-md</a> - Generate a README.md file containing information for contributors from GitHub.</li> + <li><a href="contributing-md.html">commons:contributing-md</a> - Generate a CONTRIBUTING.md file containing information on how to contribute for contributors from GitHub.</li> </ul> </p> </section> @@ -59,7 +60,7 @@ <plugin> <groupId>org.apache.commons</groupId> <artifactId>commons-build-plugin</artifactId> - <version>1.6</version> + <version>1.9</version> </plugin> ]]></source> </p>
