Versions Compared

Key

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

...

  • Any new files added in this release must have a valid license header. 
  • Make sure any new submodules or dependencies that have been added in this release have been mentioned in the top level LICENSE file - There is no test to cover this (and is a frequent cause of a -1)
  • Make sure the Apache RAT test is passing (this is ensured automatically by the PR validation check)
  • DISCLAIMER is correct, file names include “incubating”
  • Check if the license issues listed in Github are all addressed 

More Details

The top level LICENSE and NOTICE files are correct and dependency licenses are acceptable

...

Once all the PRs have been merged the final commit hash on the release branch must be tested. (You should begin testing as soon as the release branch is created, but make sure it is run atleast at least once on the final commit)

...

Follow the guides for the corresponding language bindings. Release manager can ask the help from dev@ to reach owners of different language bindings to do the validation.

Scala/Java

Follow the release process to build Scala/Java packages and include the stage repo links in the voting email:

...

  1. Add the new installation version on the install get_start page: 

2. Add

...

download links to the install archives. See this example: docs/static_

...

site/

...

3. Add download links to the install archives. See this example: docs/installsrc/pages/get_started/download.md. Make  Make sure to use the Apache distro servers.  archive.apache.org for all except the current one.

43. Update the pip package table: http:docs//mxnet.incubator.apache.org/install/ubuntu_setup.html and on the install/index.md pagestatic_site/src/_includes/get_started/linux/python/cpu/pip.md and docs/static_site/src/_includes/get_started/linux/python/gpu/pip.md.

This has a sketch file that can be updated to generate a new png image. Because this file is live and pulled from the web-data repo, you need to submit a PR to this repo with the new image. It is recommended that you add a new one with the version name. Then in your PR for the html updates, you refer to this specific new image, rather than updating the one that is used in production.

54. Set default website version to this new release version by updating the RewriteRule in /docs/static_site/src/.htaccess under comment "# Set default website version to current stable".

                 Update the version 1.x to the new release version: RewriteRule ^(.*)$ /versions/1.x/$1 [r=307,L] => RewriteRule ^(.*)$ /versions/{NEW RELEASE VERSION}/$1 [r=307,L]

6. Test the build.

  • Run make html from the docs folder while on your edit branch and make sure the changes look good. At this point you can submit your PR.
  • While the PR is clearing CI, you can also test the publish job. This job happens every 6 hours, but it is good to make sure it's going to work once your PR gets merged.
  • Run the following from the docs/build_version_doc/ folder, but update it to include the new release's branch and name:
    ./build_all_version.sh "v1.4.x;v1.3.x;v1.2.0;v1.1.0;v1.0.0;v0.12.0;v0.11.0;master" "1.4.0;1.3.1;1.2.1;1.1.0;1.0.0;0.12.1;0.11.0;master"
  • Then run the following to update the html and navigation. Make sure you add the new release version in the first parameter. Also update the last parameter to be the public IP of your staging web server. Publish the output of docs/build_version_doc/VersionedWeb to your staging server. For more details refer to building the production website.
    ./update_all_version.sh "1.4.0;1.3.1;1.2.1;1.1.0;1.0.0;0.12.1;0.11.0;master" master http://34.201.8.176/

7. (This step requires CI access. Ask on Slack for assistance if you don't have access.) Configure the Jenkins website publishing job.

Go to http://jenkins.mxnet-ci.amazon-ml.com/and find job “restricted-website-build”. Login if you're not already.

Click Configure and look for the section with the String Parameters.

Tags to build

      • If this is a minor release, the branch should already be in the first parameter "tags_to_build".
      • If this is a major release, you will need to add the branch to the list in the Default Value field. Note these are semicolon separated values.

Tag list

      • If this is a minor release, you will want to bump the version up for the branch you're updating. Example: change 1.2.0 to 1.2.1.
      • If this is a major release, you will need to add the new version number to the list. Example: add 1.3.0. Note these are semicolon separated values.

Click Save.

Click “Build with Parameters”, verify that the settings you just updated look correct, then click Build. 


5. Contact the website maintainer (Yang Shi) to check if the update are all good.

The docs will be published to http://mxnet.incubator.apache.org/. There The docs will be published to http://mxnet.incubator.apache.org/. There can be a delay due to some edge caching with Apache infra. The restricted-website-build job also runs four times a day.

...

Update the Table of Contents by deleting the one from the previous release, and generating a new one using the complete contents of news.md. You can use this markdown toc generator.

3.4.

...

Check if this release has to go out on a blog on blogs.apache.org

In order to get write access to blogs.apache.org/mxnet, one need to first register on blogs.apache.org and ask Henri (bayard@apache.org) to grant the permission.

3.5. Review the announcement email content on dev@mxnet.incubator.apache.org before sending the announcement.

3.6. Announce the release

Once everything is working (website docs, website changes, 24 hours after upload) create an announcement on the website and then send an email to the mailing list.

...

Send an email to announce@apache.orggeneral@incubator.apache.org and dev@mxnet.incubator.apache.org with the subject: [ANNOUNCE] Release Apache MXNet <release number> Release and (incubating) version $release and a body along the lines of:

Info
iconfalse


To: announce@apache.org, general@incubator.apache.org, dev@mxnet.incubator.apache.org
Subject: [ANNOUNCE] Release Apache MXNet (incubating) version $release


Dear all,

The Apache MXNet (incubating) community is happy to announce Apache MXNet (incubating) version ##.#.#!

( ## if applicable ## )

Release blog post:
https://blogs.apache.org/mxnet/entry/announcing-apache-mxnet-incubating-1
https://medium.com/apache-mxnet/announcing-apache-mxnet-1-3-0-484ea78c22ad

( ## -- if applicable -- ## )

Apache MXNet (incubating) is a deep learning framework designed for both efficiency and flexibility. It allows you to mix symbolic and imperative programming to maximize efficiency and productivity.

( ## for patch releases ## )

1.3.1 is a maintenance release incorporating important bug fixes and important performance improvements.

( ## -- for patch releases -- ## )

A full list of the changes in this release can be found in the release notes:
https://cwiki.apache.org/confluence/x/eZGzBQ

A link to the download page can be found here:
http://mxnet.incubator.apache.org/install/download.html

If you prefer to build from source and experiment with various compile-time configuration options, use this link to get the instructions:
http://mxnet.incubator.apache.org/install/index.html

Or you can download and play with MXNet easily using one of the options below:

1. The Pip packages can be found here:
https://pypi.python.org/pypi/mxnet

2. The Docker Images can be found here:
https://hub.docker.com/r/mxnet/python/

Links in Maven to the published Scala packages:

https://repository.apache.org/content/repositories/releases/org/apache/mxnet/
https://repository.apache.org/#nexus-search;quick~org.apache.mxnet

and to the experimental Clojure packages:
https://repository.apache.org/content/repositories/releases/org/apache/mxnet/contrib/clojure/

The Docker images:
https://hub.docker.com/u/mxnet/

The Pip package:
https://pypi.python.org/pypi/mxnet

The Release Tag:
release tag:
https://github.com/apache/incubator-mxnet/tree/#.#.#

MXNet Resources

- Our discussion forum (https://github.com/apache/incubator-mxnet/discussions)
- MXNet dev mailing list (https://lists.apache.org/list.html?dev@mxnet.apache.org)
- StackOverflow mxnet tag (https://stackoverflow.com/questions/tagged/mxnet)
- MXNet website (https://githubmxnet.com/apache/incubator-mxnet/tree/#.#.#MXNet Resources
- Our discussion forum .apache.org)
- Follow MXNet Development on Github (https://discuss.mxnet.iogithub.com/apache/incubator-mxnet/issues)
- MXNet user mailing list Confluence Wiki for Developers (https://listscwiki.apache.org/list.html?user@mxnet.apache.org/confluence/display/MXNET)
- MXNet dev mailing list Apache Slack #mxnet Channel (https://liststhe-asf.apacheslack.org/list.html?dev@mxnet.apache.org)
- StackOverflow mxnet tag com/archives/C7FN4FCP9)

Social Media

- Apache MXNet on Twitter (https://stackoverflowtwitter.com/questions/tagged/mxnetapachemxnet)
- Contributor and user blogs about MXNet website (https://mxnetmedium.incubator.apache.org/faq/com/apache-mxnet)
- Github issues Discuss MXNet on r/mxnet (https://githubwww.reddit.com/apacher/incubator-mxnet/issues)
- Wiki Apache MXNet YouTube channel (https://cwikiwww.apacheyoutube.org/confluence/display/MXNET)Attend one of the regular user groups meetings:
com/apachemxnet)
- Apache MXNet on LinkedIn (https://cwikiwww.apachelinkedin.orgcom/confluence/x/7BY0BQcompany/apache-mxnet)


For more information on Apache MXNet (incubating), please see:
https://mxnet.io.incubator.apache.org/


Best regards,
Apache MXNet (incubating) Team

_______

DISCLAIMER:

Apache MXNet (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

https://cwiki.apache.org/confluence/x/BINjB


...