Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The release candidate should contain all planned features, bug fixes, and code changes above. The release candidate commit should have passed the merge build, pip builds
  • Docs should also be manually built locally & checked for correctness. TODO: how to retrieve the commit hash.
  • Checkout the commit into a new branch "v#.#.x" and push it (It might be a good idea to do this in advance and freeze the branch)
  • Update NEWS and README. Examples can be followed here: NEWS.md and README.md. Note that this assumes the existence of the tag of next release, which is not created yet. Therefore, the update only happens on the release branch (not the master branch) so broken links are not visible to users.

Manual Docs Build

The build_all_versions.sh must also be updated with the correct tag

...

  • Docs should also be manually built locally & checked for correctness.
    • build and host the website locally to check the correctness.
    • More reference here: Host a MXNet Website Preview. Contact MXNet engineering team for access

Step 1.7. Test the release branch

...