releasing v0.4.0 -- checklist #1318
Description
Release a candidate version
- Tag and release PYPI version [X.Y.Z]rc[K] following the contributing guide.
- Make sure all CI pipelines pass.
- Check the PyPI page
- Test pip install monai==[X.Y.Z]rc[K] and run a few MONAI modules locally
- Test all installation commands mentioned in the installation guide and the primary README.
Quality assurance for the relevant repos
The new PyPI release candidate should be checked against all the relevant repositories under Project-MONAI, for example, the tutorials repo
- Manually run all Jupyter notebooks, replace pip install monai with pip install monai==[X.Y.Z]rc[K]. (double check all examples/tutorials tutorials#33)
Prepare documentation
- Draft a release note on GitHub. (including details about the breaking changes)
- Draft a release note with a pull request to modify the CHANGELOG.
- Create a pull request to highlight the features of the upcoming release, for example, in docs/source/highlights.md.
- Create a pull request to update the primary README.md.
- Update the monai.io website (https://github.com/Project-MONAI/project-monai.github.io).
- Check all the URLs in https://monai.io
- Check all the URLs in https://docs.monai.io.
- migration guide (for v0.3.0...v0.4.0breaking changes described in the release note)
Release a milestone version
- Tag and release PyPI version [X.Y.Z] following the contributing guide.
- Publish the release note on GitHub.
- Revisit the GitHub project tab Update https://github.com/Project-MONAI/MONAI/projects.
- Update the weekly-preview tagging https://github.com/Project-MONAI/MONAI/blob/master/.github/workflows/weekly-preview.yml#L32