mrjones-plip commented 5 months ago

Planning - Product Manager

[X] Create a GH Milestone for the release. We use semver so if there are breaking changes increment the major, otherwise if there are new features increment the minor, otherwise increment the service pack. Breaking changes in our case relate to updated software requirements (egs: CouchDB, node, minimum browser versions), broken backwards compatibility in an api, or a major visual update that requires user retraining.
[ ] Add all the issues to be worked on to the Milestone. Ideally each minor release will have one or two features, a handful of improvements, and plenty of bug fixes.
[ ] Identify any features and improvements in the release that need end-user documentation (beyond eng team documentation improvements) and create corresponding issues in the cht-docs repo
[X] Assign an engineer as Release Engineer for this release.

Development - Release Engineer

When development is ready to begin one of the engineers should be nominated as a Release Engineer. They will be responsible for making sure the following tasks are completed though not necessarily completing them.

[x] Set the version number in the package.json and package-lock.json, then submit a PR to master branch. The easiest way to do this is to use npm --no-git-tag-version version <major|minor>.
[x] Ensure that issues from merged commits are closed and mapped to a milestone.

Releasing - Release Engineer

Once all issues have been merged into master, and the master branch has the new version number, then the release process can start:

[x] Create a new release branch from master named <major>.<minor>.x in cht-core. Post a message to #development Slack channel using this template:

@core_devs I've just created the `<major>.<minor>.x` release branch. Please be aware that any further changes intended for this release will have to be merged to `master` then backported. Thanks!

[x] Build a beta named <major>.<minor>.<patch>-beta.1 by pushing a lightweight git tag (e.g. git tag <major>.<minor>.<patch>-beta.1).

[x] Once the CI completes successfully notify the team by writing a message in the #product-team Slack channel:

@product_team, I’ve just created the `<major>.<minor>.<patch>-beta.1` tag. 
Please let me know if there’s any final update we need to make. 
If all is good, then in 24h, I will start the release. Thanks!

[ ] The beta tag will automatically trigger the scalability build. Once it passes, download the scalability results on S3 at medic-e2e/scalability/$TAG_NAME. Add the release .json file to cht-core/tests/scalability/previous_results. More info in the scalability documentation.
[x] Add release notes to the Core Framework Releases page:
- [x] Create a new document for the release in the releases folder.
- [x] Ensure all issues are in the GH Milestone, they have human readable descriptions, and that they're correctly labelled. In particular: they have one "Type" label, "UI/UX" if they change the UI, and "Breaking change" if appropriate.
- [x] Use this script to export the issues into our release note format.
- [x] Collect known migration steps, descriptions, screenshots, videos, data, and anything else to help communicate particularly important changes. This information should already be on the issue, but if not, prompt the change author to provide it.
- [x] Document any required or recommended upgrades to our other products (eg: cht-conf, cht-gateway, cht-android).
- [x] Add the release to the Supported versions and update the EOL date of the previous release. Update the status of any releases that are past their End Of Life date. Also add a link in the Release Notes section to the new release page.
[x] Create a release in GitHub from the release branch so it shows up under the Releases tab with the naming convention <major>.<minor>.<patch>, and change the Target dropdown to the release branch (eg: 4.4.x). This will create the git tag automatically. Ensure the release notes PR above is merged. Link to the release notes in the description of the release.
[x] Confirm the release build completes successfully and the new release is available on the market. Make sure that the document has new entry with id: medic:medic:<major>.<minor>.<patch>
[x] Upgrade the demo instance to this version.
[x] Use cht-conf to upload the configuration from the /config/demo folder to the demo-cht.dev server.
[x] Announce the release on the CHT forum, under the "Product - Releases" category using this template:
```
*We're excited to announce the release of {{version}} of {{product}}*
```

See below for some highlights, read the release notes for full details.

Following our support policy, versions {{versions}} are no longer supported. Projects running these versions should start planning to upgrade in the near future. For more details read our software support documentation.

Check out our roadmap to see what else is currently being working on.

{{version}} Highlights

[{{Highlight 1}}]({{}})

[{{Highlight 2}}]({{}})

[And more...]({{paste-url to section}})

We’ve also implemented loads of other improvements and fixed a heap of bugs.


- [x] Add one last update to the #product-team Slack channel and use the thread to lead an internal release retrospective covering what went well and areas to improve for next time.
- [x] Add any open "known issues" from the prior release that were not fixed in this release. Done by adding the correct `Affects: 4.x.x` label.  
- [x] Mark this issue "done" and close the Milestone.