Release Checklist

Stuff to do before a release

Note: These apply to the release process using Go to build and deploy the zip.

• Make sure the build for the develop branch is green.
• We currently run the Java model tests on Travis and the full build (Java and JS) on an inhouse Go CI server. Once BRJS and the build can run tests on SauceLabs (or equivalent) we will move the whole build to Travis.
• Write and review the release notes.
• These are kept in the 'releases' folder in the root of the brjs directory. Its easiest to copy an existing .md and .json file and rename it for the next release.
• See https://github.com/BladeRunnerJS/brjs/wiki/Automated-Release-Process for more information about the automated release process.
• Make sure all issues for the release are associated with the correct milestone, the milestone ID(s) are correct in the .json file copied above, and each issue has the correct labels.
• See https://github.com/BladeRunnerJS/brjs/wiki/Automated-Release-Process for more information about what part milestones and labels place in the release process.
• Create a pull request from develop -> master so it can be QA'd and reviwed.
• Once the pull request has been merged across to master make sure the build for master is green and create an annotated tag for the release version.
• git tag -a vX.Y -m 'BladeRunnerJS version X.Y'; git push origin vX.Y
• Trigger the deploy task in Jenkins. This will generate the release notes from the freeform .md file in 'releases' along with the issues from the release milestone(s).
• Push a new version of the Java and JS API docs to the 'brjs-api-docs' repo. These can either be copied from the zip that's automatically pushed to GitHub or from a version built manually using the new tag.
• JS docs should go in '/vX.Y/js' and Java docs in '/vX.Y/java'.