Release checklist

Milestone Release Checklist (for the maintainers)

Release a candidate version

• Tag and release PYPI version [X.Y.Z]rc[K] following the contributing guide.
• Make sure all CI pipelines pass.

Verify the new PyPI release

• 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:

• Run all Jupyter notebooks, replace pip install monai with pip install monai==[X.Y.Z]rc[K].
• File new tickets and create new pull requests to address any technical issues.
• Release a new candidate after addressing all the issues.
• Testing related repositories
  • MONAI unit and integration tests
  • MONAI tutorial tests (per file checklist https://github.com/Project-MONAI/MONAI/discussions/6603)
  • MONAILabel unit and integration tests
  • MONAI model zoo tests
  • QA regression tests

Prepare documentation

• Draft a release note on GitHub.
• 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.

Release a milestone version

• Tag and release PyPI version [X.Y.Z] following the contributing guide.
• Check the dockerhub auto-build by running docker pull projectmonai/monai:X.Y.Z and docker run ...
• Check jupyter lab/notebook in the docker container
• Check readme frontpage on dockerhub, pypi
• Update https://github.com/Project-MONAI/MONAI/blob/dev/CITATION.cff
• Publish the release note on GitHub.
• Update the weekly-preview tagging https://github.com/Project-MONAI/MONAI/blob/master/.github/workflows/weekly-preview.yml#L32
• Release the corresponding conda-forge version https://github.com/conda-forge/monai-feedstock

Revisit the GitHub project tab

• Update https://github.com/Project-MONAI/MONAI/projects.

Review the deprecated APIs

• remove any promised deprecated functionality