Gradle

Introduction

PCGen is now built using the Gradle build tool.

Installing Gradle

See [Gradle Install Guide] for a tutorial on installing Gradle. It is pretty simple though.

Main Tasks

These are the tasks which you are more likely to use everyday. All tasks are run using gradle taskname . If you run gradle without any tasks it will run clean and build by default. Tasks names are not case sensitive.

clean

Clean erases all output from previous builds and sets all tasks to be rerun (not up to date).

build

Compile PCGen, rebuild the plugin jars, run the fast unit tests and make the pcgen.jar file. Note this also stamps the build with the SVN revision, which can be seen in the PCGen About window.

slowtest

Runs the full suite of tests including the character integration tests and the data tests.

datatest

Run just the data related tests.

inttest

Runs just the character integration tests.

Useful Tasks

Here are some of the other tasks which you may wish to use.

javadoc

Produce the javadoc.

allReports

Produce the code quality reports for the main code only (not the test folders).

pfinttest

Runs just the Pathfinder character integration tests.

fullZip

Produce the full PCGen zip file as used in the autobuild and the release.

prepareRelease

Prepare PCGen for release. This will update and commit the version, do a clean build including the unit tests and generate the data list for the installer.

pcgenRelease

Release a new version of PCGen. This will build PCGen, produce the release artifacts, tag the release and then update and commit the version ready for new dev work. The upload to SourceForge is manual though!