Versions Compared

Key

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

...

Note: From version 1.3 all branches are created with a name v1.3.x to make patch releases easier. For patch releases cutting a new branch is not necessary. Fixes for patch releases should be merged to v#.#.x branch and latest commit should be tagged with an exact version number, ie v1.3.1.

  • To create a new major or minor branch use (replace v1.4.x with actual branch name):

    git branch <branchname, e.g.

     

    Code Block
    languagebash
    titleGit branch creation
    # checkout clean master branch
    git clone https://github.com/apache/incubator-mxnet.git
    cd incubator-mxnet
    git branch v1.4.
    x>;
    x
    git push --set-upstream
    origin <branchname, e.g.
     origin v1.4.
    x>
    x


  • 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. An example can be followed here: https://github.com/apache/incubator-mxnet/pull/6471. 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.

...