PLDoc code comprises:-
The PLDoc build process comprises:-
Generating the parser takes the most time of the build process (approximately 30 minutes) and is unnecessary if changes are made only to Java, XLST or batch/shell scripts.
mvn package Compilation including JavaCC generation mvn -D skipJavacc=true package Compilation skipping JavaCC generation mvn install Compile and install artefacts into local repository (required for subsequent use in maven-pldoc-plugin)
Since PLDoc version 1.1.3 Maven may require a larger heap size to complete JavaCC generation; when I encountered generation errors, I specified lots of heap memory just to get the parser generated, i.e.
Site generation takes much less time (less than 2 minutes).
mvn site Site generation to target directory mvn site:deploy Refresh site at Sourceforge
New versions should be released using the Maven release plugin which automates a lot of the steps needs to create a successful release. A successful release will automatically be deployed to the central Maven repository, via rsync synchronisation. The synchronisation process may take several days.
For more information about the steps required to deploy to Sourceforge, refer to Deployment to Sourceforge.
The prepare step takes a significant amount of time, simply because the build process is performed twice, once to validate the project and once to build the release artefacts.
mvn release:prepare Validate code tree (including build), extract code from SCM and build ssh -t <username>,email@example.com create Create remote Sourceforge shell required for site deployment mvn release:perform Deploy release artefacts to Sourceforge and update pldoc.sourceforge.net site