MONAI icon indicating copy to clipboard operation
MONAI copied to clipboard

releasing v1.5 -- checklist

Open KumoLiu opened this issue 8 months ago • 3 comments

tentative: 18th Apr

Review the deprecated APIs

  • [x] remove any promised deprecated functionality

Release a candidate version

  • [x] Tag and release PYPI version [X.Y.Z]rc[K] following the contributing guide, need trigger release pipeline on blossom.
  • [ ] Make sure all CI pipelines pass.

Verify the new PyPI release

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:

  • [x] Run all Jupyter notebooks, replace pip install monai with pip install monai==[X.Y.Z]rc[K].
  • [x] File new tickets and create new pull requests to address any technical issues.
  • [x] Release a new candidate after addressing all the issues.
  • [x] Testing related repositories
    • [x] MONAI unit and integration tests
    • [x] MONAI tutorial tests
    • [x] MONAILabel unit and integration tests
    • [x] MONAI model zoo tests
    • [x] QA regression tests

Prepare documentation

  • [x] Draft a release note on GitHub.
  • [x] Draft a release note with a pull request to modify the CHANGELOG.
  • [x] Create a pull request to highlight the features of the upcoming release, for example, in docs/source/highlights.md.
  • [x] Create a pull request to update the primary README.md.
  • [x] Update the monai.io website (https://github.com/Project-MONAI/project-monai.github.io).
  • [x] Check all the URLs in https://monai.io
  • [x] 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.
  • [x] Check the dockerhub auto-build by running docker pull projectmonai/monai:X.Y.Z and docker run ...
  • [x] Check jupyter lab/notebook in the docker container
  • [x] Check readme frontpage on dockerhub, pypi
  • [x] Update https://github.com/Project-MONAI/MONAI/blob/dev/CITATION.cff
  • [ ] Publish the release note on GitHub.
  • [x] Update the weekly-preview tagging https://github.com/Project-MONAI/MONAI/blob/master/.github/workflows/weekly-preview.yml#L32 and https://github.com/Project-MONAI/MONAI/blob/master/.github/workflows/weekly-preview.yml#L69
  • [ ] 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.

KumoLiu avatar Apr 11 '25 13:04 KumoLiu

There is also a RC tag: https://github.com/Project-MONAI/MONAI/releases/tag/1.4.1rc1

Will that ever be released as 1.4.1?

ziw-liu avatar May 08 '25 16:05 ziw-liu

Hi @KumoLiu,

Do you have an idea of when this new version will be released? We'd love to use MONAI within @brainglobe, but we need support for numpy>2.

Thanks!

adamltyson avatar May 27 '25 12:05 adamltyson

Same here. Can work on a few PRs too

arthurdjn avatar May 29 '25 09:05 arthurdjn

I'd also like to have numpy>= 2.0 enabled. Please assign issues/PRs to me to enable this 🙂

marcimarc1 avatar Jul 28 '25 16:07 marcimarc1

v1.5 has already been released a while ago. There just haven't been an announcement.

matham avatar Jul 28 '25 16:07 matham

Hi @matham, if you watched the repo, you will get an release email. Image

KumoLiu avatar Jul 29 '25 03:07 KumoLiu