...
- Firstly, create a branch for the version you are about to release from master, ie `release/3.0.x`.
- If releasing a bugfix/hotfix, then create branch from relevant version tag: `git checkout -b release_3.0.1 v3.0.0`
- Then cherry pick relevant commits into the release branch: `git cherry-pick <commit hash>` and check they still pass integration tests.
- Then update the changelog `NEWS.md` file to reflect all JIRA issues solved since the previous release.
- Make sure to remove (IN PROGRESS) from relevant section, and replace with today's date.
- Also ensure you remove `-SNAPSHOT` from the version number if it was there previously.
An easy way is to go to [this page](https://issues.folio.org/browse/ERM-54?jql=project%20%3D%20erm%20AND%20resolution%20is%20not%20EMPTY%20AND%20resolution%20!%3D%20%22Cannot%20Reproduce%22%20AND%20resolution%20!%3D%20%22Won%27t%20Do%22%20AND%20resolutiondate%20%3E%3D%202021-06-15%20AND%20component%20%3D%20mod-agreements%20ORDER%20BY%20created%20ASC) and this page and filter by date updated/component. Also check the commits for the module to see if any other issues are referenced there.
When you have a parent issue and subtasks, they should appear in the changelog in a nested form, like so:```
| Info | ||
|---|---|---|
| ||
* ERM-904 Update tooling and framework * ERM-906 Update licenses to Grails 4 * ERM-909 Update docker image to Java 11 |
...
- Commit changelog changes and push up to github
- If doing a bugfix, first increment version number by 1 on patch, ie 3.0.0 -> 3.0.1, then raise a PR and merge to long life release branch, ie release_v3.0.x.
- DO NOT MERGE BACK TO MASTER
- Go to your branch on github, select "releases" on the left hand side and "draft new release". Make sure the Target is set to your release branch, and the tag is of the form `vx.y.z`, ie `v3.0.0` or `v5.2.1` etc. Give the release a name, `Version 3.0.0` and fill in the explanation with the changes you already made to the changelog, along with the header:
...
| Info | ||
|---|---|---|
| ||
## 3.0.0 2020-10-14 * ERM-1046 Non-phrase searching support for licenses * ERM-967 Add "Note" to Organisation link in Licenses * ERM-904 Update tooling and framework * ERM-906 Update licenses to Grails 4 * ERM-909 Update docker image to Java 11 * ERM-828 Add support for "Alternative name" for licenses * ERM-975 Licenses: Use /organizations/ instead of /organizations-storage/ * ERM-742 Custom properties: Backend validation not working |
```for example. Then click "publish release".
...
- Head to the jenkins build page (you will need to log in with your github credentials):
- [mod-agreements](https://jenkins-aws.indexdata.com/job/folio-org/job/mod-agreements/view/tags/)[mod-licenses](https://jenkins-aws.indexdata.com/job/folio-org/job/
- mod-licenses/view/tags/)
- [mod-service-interaction](https://jenkins-aws.indexdata.com/job/folio-org/job/mod-service-interaction/view/tags/)[mod-serials-management](https://jenkins-aws.indexdata.com/job/folio-org/job/
- mod-serials-management/view/tags/)
find your new tag, and select "Build now" from the dropdown menu next to the tag name. (Alternatively select tag and then "Build now" from the menu on the left hand side of the screen)
- Once that's done, double check the release has made it here:
- [mod-agreements](https://hub.docker.com/r/folioorg/mod-agreements/tags)[
- mod-licenses](https://hub.docker.com/r/folioorg/mod-licenses/tags)[mod-service-interaction](https://hub.docker.com/r/folioorg/
- mod-service-interaction/tags?page=1&ordering=last_updated)
- [mod-serials-management](https://hub.docker.com/r/folioorg/mod-serials-management/tags)
- Announce the release on slack channel `#releases`, with message
...
| Info | ||
|---|---|---|
| ||
| mod-licenses v3.0.0 released https://github.com/folio-org/mod-licenses/releases/tag/v3.0.0 |
with a link to the github tagged release page.
...