Versions Compared

Key

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

...

  1. Bump up the version number. An example can be followed here: https://github.com/apache/incubator-mxnet/pull/6462, update https://github.com/apache/incubator-mxnet/blob/master/setup-utils/install-mxnet-osx-python.sh#L36
    More recent example - https://github.com/apache/incubator-mxnet/pull/8567
    make sure no broken/non-existing links are added to the master branch.
  2. Update NEWS and README. An example can be followed here: https://github.com/apache/incubator-mxnet/pull/6471
  3. Create a RSA GPG key of length 4096, upload it to the public server, and add it to the KEYS file (do this process once for each release manager): https://github.com/apache/incubator-mxnet/blob/master/KEYS & https://dist.apache.org/repos/dist/dev/incubator/mxnet/KEYS See more detailed instructions on creating the key here: https://www.apache.org/dev/openpgp.html#generate-key

    Code Block
    languagebash
    titleAdding Keys
    # checkout the apache mxnet repo
    svn co https://dist.apache.org/repos/dist/dev/incubator/mxnet apache-mxnet
    cd apache-mxnet
    # update the KEYS file ...
    # commit the update
    svn commit -m “update keys file for xxx ” --username your_username --password your_passwd

Step 4. Cut

...

the Release

...

Branch

  1. 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, nightly tests. Docs should also be manually built locally & checked for correctness. TODO: how to retrieve the commit hash.
  2. Manual Docs Build - 
    1. The build_all_versions.sh must also be updated with the correct tag
    2. This script must be built locally to test docs (confirmprocedure with Santhosh, Yao) and automate after 0.12.0.

      Tag release candidate (To be done by a committer)

3. Checkout the commit into a new branch "v#.#.#" and push it (It might be a good idea to do this in advance and freeze the branch)

      Step 5. Tag release candidate (To be done by a committer)

  1. Go to the GitHub repo’s “releases” tab
  2. Click “Draft a new release”
      • Provide the release tag in the form of “0“1.120.0.rc0” where 0 means it’s the first release candidate
      • Select the commit by clicking Target: branch > Recent commits > $commit_hash 
      • Copy and paste NEWS.md change into the description box from here
      • Select “This is a pre-release"
    (question)
  1. This

Step 6. This step has not been done in the

...

past 

Tag all the dependent submodules for every MXNet release. If a code-change (e.g. bug-fix) is required to a dependent sub-module then we take a branch from the tag and apply the code-change only to the branch for the sub-module so that the change is minimal. This should allow the MXNet release process to have better convergence towards a stable release.

 

Step 7. Create artifacts for the release and push to the dist folder

a) The src tar - apache-mxnet-src-#.#.#.rc0-incubating.tar.gx:

...

Code Block
languagebash
titleUploading to dist
# Checkout the Apache directory in Apache distribution SVN "dev" repo
$ svn co https://dist.apache.org/repos/dist/dev/incubator/mxnet
# select p
# Make directory for this RC in the above directory
$ cd mxnet
$ mkdir #.#.#.rc0
# Move artifacts into this folder
$ cp ../apache-mxnet-src-#.#.#.rc0-incubating.tar.gz* #.#.#.rc0
$ svn add #.#.#.rc0
$ svn commit -m "Add mxnet-#.#.#.rc0" --username "lxn2"

Step

...

8. Validate release package (Committer or Contributer)

As per the Apache documentation, verify that the release candidate artifacts satisfy the following:

...