Release process
This page is meant for OpenGrok developers.
The version string is in the form of x.y.z. If y or x changes, this usually requires reindex from scratch. If only z changes, just redeploy new web application and keep going.
The release process uses continuous integration which means the code base should be ready to release any time.
That said, Ideally, the following minimum criteria should be fulfilled before a new final (i.e. non-prerelease) version is released:
- The overall code coverage must be at least 70%
- Sonarcloud reported bugs should not have any critical issues
- No stoppers (meaning both Issues and Pull requests)
- All bugs and enhancements must be evaluated (for final release also go through issues with given milestone and either fix them or retarget to next release by setting the new milestone)
The below steps are common for both pre-release and final release:
-
check that latest build passes tests, test code coverage is above given threshold
If extra care is needed (significant changes since the last release, etc.), consider checking the following:
- index fairly large code base, ideally multiple projects
- deploy webapp
- check UI:
- history view
- try comparing 2 distant revisions
- check pagination
- annotate view
- directory listing
- check sorting using multiple criteria
- perform search using multiple fields across multiple projects
- history view
The release is OK, once above is fulfilled to our satisfaction.
-
Trigger release creation
./dev/release INSERT_VERSION_HERE -
Wait for the build to finish and release created.
Go to https://github.com/OpenGrok/OpenGrok/releases and edit the text of the release, e.g. adding list of issues fixed, whether complete reindex is necessary etc.
-
If there was a change in RESTful API, make sure to update the Apiary. Currently this has to be done by hand, because the hooks that performed automatic update had to be removed because of internal policy.
