Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added a section on testing a RC (step 2.2.)

...

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 1.10. Create

...

artifacts for the release and push to the dist folder

The src tar - apache-mxnet-src-#.#.#.rc0-incubating.tar.gz:

...

Info
iconfalse
titleOpening vote email template


To: dev@mxnet.apache.org
Subject: [VOTE] Release Apache MXNet (incubating) version $release.rc0

Dear MXNet community,

This is the vote to release Apache MXNet (incubating) version $release. Voting will start $start-date-time and close on $end-date-time, $time-zone.

Link to release notes:
https://cwiki.apache.org/confluence/<tiny-link>

Link to release candidate:
https://github.com/apache/incubator-mxnet/releases/tag/$release.rc0

Link to source and signatures on apache dist server:
https://dist.apache.org/repos/dist/dev/incubator/mxnet/$release.rc0/

Link to scala packages on the staging repo:

* CPU
https://repository.apache.org/content/repositories/snapshots/org/apache/mxnet/<link>

* GPU
https://repository.apache.org/content/repositories/snapshots/org/apache/mxnet/<link>

Please remember to TEST first before voting accordingly:
+1 = approve
+0 = no opinion
-1 = disapprove (provide reason)


Best regards,
$RM

Step 2.2.

...

Testing Release Candidate (for Contributors)

There are 3 ways of getting the source code for the release candidate

  1. Check out tag
    Method 1
    git clone --recursive https://github.com/apache/incubator-mxnet.git
    git checkout tags/<tag_name> -b <branch_name>

    Method 2
    git clone --recursive https://github.com/apache/incubator-mxnet.git --branch=<tag_name>
  2. Download the zip on Github Source page
    https://github.com/apache/incubator-mxnet/tags
  3. Download the distribution
    https://dist.apache.org/repos/dist/dev/incubator/mxnet/

Once checked out, follow the steps to build mxnet from source [1] and then various tests can be run.
It is recommended that contributors test out parts of the MXNet codebase they have touched. This ensures greater coverage of the testing and reduces the risk of running into errors post release.

Note: CPU vs GPU, MKLDNN : ON/OFF, Linux vs Centos vs Windows vs Mac are various configurations possible.
Make sure to verify the build flags before running the tests on the release candidate.

[1] https://mxnet.apache.org/get_started/build_from_source

Step 2.3. Send out the vote results on dev@

Info
iconfalse
titleVote results email template


To: dev@mxnet.apache.org

Info
iconfalse
titleVote results email template

To: dev@mxnet.apache.org
Subject: [RESULTS] [VOTE] Release Apache MXNet (incubating) version $release.rc0

Dear MXNet community,

I'm happy to announce the results of the vote.

This vote passes with <num> +1 votes (<num> binding) and no 0 or -1 votes.

+1 votes
* <name> / binding
* <name> / binding
* <name>
* <name>

0 votes
* No votes

-1 votes
* No votes

Vote thread can be found here [1]. The list of members can be found here [2].

I'll continue with the release process and the release announcement will follow in the next few days.


Best regards,
$RM

[1] https://lists.apache.org/thread.html/<link>
[2] http://incubator.apache.org/projects/mxnet.html

Step 2.

...

4. Triage issues and re-vote if necessary 

Should any vote fail to reach quorum or release lead determines that another RC needs to go out, the release lead should triage the issues, create GitHub issues, and move to fix the issues. Once fixed, make changes to NEWS & README.md in case it specifically lists the old RC# number. Start the process for another release candidate. In the new voting email, detail what has changed since the last release candidate. Repeat until the vote passes.

Info
iconfalse
titleCancel vote template


To: dev@mxnet.apache.org
Subject: [CANCELLED] [VOTE] Release Apache MXNet (incubating) version $release.rc0

Dear MXNet community,

We are cancelling this vote because:

...

We will address the issues and send out rc#+1 for another vote.

Best regards,
$RM

Step 2.

...

5. Start a vote on general@

For the vote on general@, anyone can contribute a vote, but only "Incubator PMC" (IPMC) votes are binding.
To pass, there must be 3 binding +1 votes and more +1 votes than -1 votes.

...

Info
iconfalse
titleVote on @general email template


To: general@incubator.apache.org
Subject: [VOTE] Release Apache MXNet (incubating) version $release.rc0


Dear community,

This is a call for a releasing Apache MXNet (incubating) #.#.#, release
candidate #.

Apache MXNet (incubating) community has voted and approved the release.

Vote thread:
https://lists.apache.org/#######

Result thread:
https://lists.apache.org/#########

The source tarball, including signatures, digests, etc. can be found at:
https://dist.apache.org/repos/dist/dev/incubator/mxnet/########

The tag to be voted upon is #########:
<link>

The release hash is #########:
<link>

Release artifacts are signed with the following key:
<link/fingerprint>

KEYS file available:
<link>

For information about the contents of this release, see:
<link to release notes>

The vote will be open for 72 hours.

[ ] +1 release this package as #########
[ ] +0 no opinion
[ ] -1 do not release this package because...

Best regards,
$RM

Step 2.

...

6: Send out the vote results on general@

Send out an email on general@ in the same voting thread which you sent in previous step to summarize the result.

...