This page contains information about project management tasks. The target audience is senior developers (and above).
Before making a release, please check the following prerequisites:
1.8.0installed (Not other major release versions such as JDK
JAVA_HOMEenvironment variable is correctly set to your JDK installation directory. You can refer to the JDK Installation Guide.
masterbranch into both the local and upstream
releasebranch according to the following steps:
masterbranch to be exactly the same as the upstream
releasebranch, and merge the
masterbranch into it with
git merge master --no-ff(no fast forward to keep the commit history for releases).
releasebranch directly to the upstream
releasebranch (make sure you have the push access).
To make a release for RepoSense on GitHub, please follow the
Creating a release section in the GitHub Docs.
Take note of the following when making the release according to the above guide:
MAJOR.MINORas the version number when the release includes new features and/or major changes.
MAJOR.MINOR.PATCHas the version number when the release only includes bug fixes and/or minor changes.
rcto the version number to indicate that the release is a pre-release that is not ready to be used in production.
xxxis the version number. Enter the release description by referring to the previous RepoSense releases.
RepoSense.jarfile and attach it to the release.
gradlew --versionto check that the JDK version is 1.8.0.
gradlew shadowJar, and the Jar file will be generated at
After making the release, please also remember to deploy the production website using the deploy guide.
We have two versions of the website:
masterbranch is updated
The production website differs from the dev website in some ways, e.g.,
CNAMEfile (to indicate that it is the target destination for the
MarkBind mainly manages these variations via the
site.config file. That is why the
site.config file in the
release branch is slightly different from the one in the
After each release, do the following steps to deploy the production website:
markbind deploy(make sure you have the push access to https://github.com/reposense/reposense.github.io)
If critical bugs are found in the release, take the following steps to hot patch it:
releasebranch to the upstream
releasebranch according to the above guide.
releasebranch back into the
masterbranch by creating a separate pull request.