The generate-xdocs.build.xml Ant build script contains targets for the following goals:
This script generates custom xdoc pages for Commons components using templates and Ant's filtering functionality:
These goals (re-)generate xdoc files in either the default m1 location (i.e. xdocs
) or the default m2 location
(i.e. src/site/xdoc
). Once generated these can be checked into svn and the component's site regenerated using mvn site
.
The commons:jira-page
goal generates a custom JIRA Issue Tracking page for a component.
Execute the goal using the following command:
mvn commons:jira-page
Note: The Issue tracking page should only need to be generated initially for a component or if the issue tracking template changes.
This goal uses the following:
jira-page
mojo defintion in the
generate-xdocs.mojos.xml
mapping documentjira-page
target in
generate-xdocs.build.xml
ant script
To generate a JIRA page, the following properties
are configured in the component's pom.xml
Example configuration for Commons Chain:
<properties> <commons.jira.id>CHAIN</commons.jira.id> <commons.jira.pid>12310462</commons.jira.pid> </properties>
The commons:download-page
goal generates a custom Download page for the latest release of a component.
Execute the goal using the following command:
mvn commons:download-page
Note: The Download page should only need to be re-generated after a new release of the component or if the download page template changes.
This goal uses the following:
download-page
mojo defintion in the
generate-xdocs.mojos.xml
mapping documentdownload-page
target in
generate-xdocs.build.xml
ant scriptcommons.release.version
property is set or not.
To generate a Download page, the following properties
are configured in the component's pom.xml
-bin
) The suffix for the binary release
(some components use "-bin", others have no suffix)Example configuration for Commons Chain:
<properties> <commons.componentid>chain</commons.componentid> <commons.release.version>1.1</commons.release.version> <commons.binary.suffix></commons.binary.suffix> </properties>
The commons:sandbox-jira-page
goal generates a custom JIRA Issue Tracking page for a Sandbox
component.
Execute the goal using the following command:
mvn commons:sandbox-jira-page
Note: The Issue tracking page should only need to be generated initially for a component or if the issue tracking template changes.
This goal uses the following:
sandbox-jira-page
mojo defintion in the
generate-xdocs.mojos.xml
mapping documentsandbox-jira-page
target in
generate-xdocs.build.xml
ant script