Release Instructions

From PCGen
Jump to: navigation, search


Here are the steps to follow when making a release of PCGen. If it is your first time, please check the prereqs section at the bottom of this page.


The first time you run a release you will have to make sure you have the following tools available:

Release Notes

  • Text editor
  • Web browser
  • Perl interpreter
  • Perl modules: readonly (installed on Windows via ActivePerl's Perl Package Manager)


  • Java SDK 1.8 (the one that includes the javac compiler) --FOR PCGEN 6.07.x
  • Gradle 1.x
  • git
  • Perl interpreter
  • NSIS

Outstanding Issues

You need to check JIRA for any outstanding issues to ensure the release meets our QA std.

  • Alpha releases require no Blockers, allow Critical only with Code lead exception
  • Beta releases require no Blockers or Criticals
  • RCs/final releases require no Blockers, Criticals, or Majors

Create Release Notes

  1. Update your local copy of pcgen from github
  2. Copy the previous set of release notes to pcgen-release-notes-nnn.html where nnn is the version number.
  3. Do a global replace of the old version number to the new version number, both as n.nn.n and nnnn
  4. Open Jira and for each project open the release notes for the version.
  5. Copy the html to the changelog section, changing h2 tags to h3.
  6. Update the What's New section with any high profile changes.
  7. Update the Thanks section with the list of people who committed during the cycle. The search filter "is:pr is:closed is:merged updated:>2015-02-09" is useful for triming the list of pull request to those included in the release.
  8. Commit the new release notes and notify pcgen_bod so they can review it.
  9. Notify pcgen dev and experimental lists of upcoming release, asking for autobuilds to be tested. Best to give 24 hours notice.

The Build

  1. Using a clean directory with no changes to the pcgen files
  2. git pull master the PCGen repository (5 mins)
  3. Release manager edits pcgen/code/src/java/pcgen/resources/prop/ to set the release date, version number, contributors, etc. and commit the result (5 mins)
  4. If switching to or from RC mode, edit and adjust the version number to be in the correct format. e.g. 6.04.00 RC1 or 6.04.00
  5. Execute gradle prepareRelease slowtest OR IF USING WINDOWS (gradle prepareRelease slowtest --project-cache-dir c:\gradle\cache) in the pcgen directory and verify there are no failing Junit test. Also check if there are any "Unknown publisher" messages. If so you need to add new entries for the listed publishers to the script. (20 mins)
  6. Check Jira for any closed requests missing from the release notes. Steps 4 and 6 of 'Create Release Notes' section above can be used to assist here. (10 mins)
  7. Update the file with the what's new section of the release notes.
  8. Smoke test the newly built pcgen full zip or exe. (30 mins)
  9. Create a folder for the release under the File Manager
  10. Upload the release notes using the File Manager to the release folder
  11. Run gradle pcgenRelease OR IF USING WINDOWS (gradle pcgenRelease --project-cache-dir c:\gradle\cache) (which updates the gradlefiles and tags the SVN repository). (2 mins)
  12. Upload the release files to SourceForge. The quickest way is uploading via the web, the same way you uploaded the release notes etc. (10 mins)
  13. Update Readme.MD with the SHA256 checksums from target/SHA256-digests.txt. Upload the revised file and check-in. (5 mins)
  14. Notify PCGen_bod of the new release. (5 mins)
  15. PR Monkeys create a news item for the new release
  16. PR Monkeys send announcement to all pcgen mailing list for the new release

Update JIRA

For each of the projects, mark the version you are working on as released and create the next version if it doesn't already exist. When marking a version as released, please make sure the released date is set to today.

Mac Installer

See Instructions


For Production Cycle Autobuilds the file code\gradle\autobuild.gradle lines 16-18 needs to be set to:

  destAutobuildDir = '/home/pcgen1/public_html/autobuilds-prod/'
  } else {
  destAutobuildDir = "${buildDir}/autobuilds-prod/"

Signing Files with PGP

Historical only We used to use the [GnuPG for Windows] to generate the signatures. You will need the private key, either your own, or the PCGen one (contact the PCGen BOD). Once GnuPG is installed and knows about the key you wish to use, it is just a matter fo right clicking on the files to be signed (multi-select is fine) and selecting GPGee > Sign and then making sure the PCGen key is selected, hitting OK and entering the passphrase for the key. This creates an .asc signature file for each selected file.


Yes, even the best installs of all the program amount to nothing if there is a hitch. These are basic notes from the current issues cropping up and resolutions. These notes are not prettified yet. The idea being we will get a full set of troubleshooting tips and tricks here in the near future.

Check your versions. JDK1.8 is required with JAVA_HOME variable (see below) My Computer > System > Advanced Settings: For JAVA_HOME make sure it's a set System Variable and make sure it's using the correct path to your current installation base folder


SVN must be a true .exe install, TortoiseSVN will not meet this requirement SVN exe can be found here [SVN]