How To Release Mahout

This page is prepared for Mahout committers. You need committer rights to create a new Mahout release.

Release Planning

Start a discussion on mahout-dev about having a release, questions to bring up include:

Code Freeze

For 7-14 days prior to the release target date, have a "code freeze" where committers agree to only commit things if they:

  • Are documentation improvements (including fixes to eliminate Javadoc warnings)
  • Are new test cases that improve test coverage
  • Are bug fixes found because of improved test coverage
  • Are new tests and bug fixes for new bugs encountered by manually testing

Steps For Release Engineer

Before building release

  1. Check that all tests pass after a clean compile: mvn clean test
  2. Check that there are no remaining unresolved Jira issues with the upcoming version number listed as the "Fix" version
  3. Publish any prev. unpublished Third Party Deps: Thirdparty Dependencies

Previewing the Artifacts

  1. To build the artifacts:
  2. mvn -Pmahout-release,apache-release,hadoop2 package

Making a release

  • Check if documentation needs an update
  • Update the web site's news by updating a working copy of the SVN directory at https://svn.apache.org/repos/asf/mahout/site/new_website
  • Commit these changes. It is important to do this prior to the build so that it is reflected in the copy of the website included with the release for documentation purposes.
  • If this is your first release, add your key to the KEYS file. The KEYS file is located on Github at https://github.com/apache/mahout/master/distribution/KEYS and copy it to the release directory. Make sure you commit your change. See http://www.apache.org/dev/release-signing.html.
  • Ensure you have set up standard Apache committer settings in ~/.m2/settings.xml as per this page .
  • Add a profile to your ~/.m2/settings.xml in the section with:

mahout_release YOUR PGP KEY NAME YOUR SIGNING PASSCODE HERE

mahout.releases::default::https://repository.apache.org/service/local/staging/deploy/maven2/ USERNAME

https://repository.apache.org/service/local/staging/deploy/maven2/

  • You may also need to add the following to the section in ~/.m2/settings.xml in order to upload artifacts (as the -Dusername= -Dpassword= didn't work for Grant for 0.8, but this did):

    apache.releases.https USERNAME PASSWORD

  • Set environment variable MAVEN_OPTS to -Xmx1024m to ensure the tests can run

  • export _JAVA_OPTIONS="-Xmx1g"
  • If you are outside the US, then svn.apache.org may not resolve to the main US-based Subversion servers. (Compare the IP address you get for svn.apache.org with svn.us.apache.org to see if they are different.) This will cause problems during the release since it will create a revision and then immediately access, but, there is a replication lag of perhaps a minute to the non-US servers. To temporarily force using the US-based server, edit your equivalent of /etc/hosts and map the IP address of svn.us.apache.org to svn.apache.org.
  • Create the release candidate:

    mvn -Pmahout-release,apache-release,hadoop2 release:prepare release:perform

If you have problems authenticating to svn.apache.org, try adding to the command line

  -Dusername=\[user]\ -Dpassword=\[password\]

If it screws up, first try doing:

mvn -Dmahout-release,apache-release,hadoop2 release:rollback.

followed by

mvn -Dmahout-release,apache-release,hadoop2 release:clean

This will likely save you time and do the right thing. You may also need to delete the tag in source control:

git tag -d mahout-X.XX.X; git push apache :refs/tags/mahout-X.XX.X

You may also have to rollback the version numbers in the POM files.

If you want to skip test cases while rebuilding, use

mvn -DpreparationGoals="clean compile" release:prepare release:perform

  • Review the artifacts, etc. on the Apache Repository (using Sonatype's Nexus application) site: https://repository.apache.org/. You will need to login using your ASF SVN credentials and then browse to the staging area.
  • Once you have reviewed the artifacts, you will need to "Close" out the staging area under Nexus, which then makes the artifacts available for others to see.
    • Log in to Nexus
    • Click the Staging Repositories link in the left hand menu
    • Click the Mahout staged one that was just uploaded by the release:perform target
    • Click Close in the toolbar. See https://docs.sonatype.org/display/Repository/Closing+a+Staging+Repository for a picture
    • Copy the "Repository URL" link to your email; it should be like https://repository.apache.org/content/repositories/orgapachemahout-024/
  • Call a VOTE on dev@mahout.apache.org. Votes require 3 days before passing. See Apache [release policy|http://www.apache.org/foundation/voting.html#ReleaseVotes] for more info.
  • If there's a problem, you need to unwind the release and start all over.

    mvn -Pmahout-release,apache-release,hadoop2 versions:set -DnewVersion=PREVIOUS_SNAPSHOT

    mvn -Pmahout-release,apache-release,hadoop2 versions:commit
    
    git commit
    
    git push --delete apache <tagname> (deletes the remote tag)
    git tag -d tagname (deletes the local tag)
    
  • Release the artifact in the Nexus Repository in the same way you Closed it earlier.

  • Add your key to the KEYS file at http://www.apache.org/dist/mahout//
  • Copy the assemblies and their supporting files (tar.gz, zip, tar.bz2, plus .asc, .md5, .pom, .sha1 files) to the ASF mirrors at: people.apache.org:/www/www.apache.org/dist/mahout//. You should make sure the group "mahout" owns the files and that they are read only (-r--r--r-- in UNIX-speak). See [Guide To Distributing Existing Releases Through The ASF Mirrors|http://jakarta.apache.org/site/convert-to-mirror.html?Step-By-Step] and the links that are there.
    • cd /www/www.apache.org/dist/mahout
    • mkdir
    • cd
    • wget -e robots=off --no-check-certificate -np -r https://repository.apache.org/content/groups/public/org/apache/mahout/apache-mahout-distribution//
    • mv repository.apache.org/content/groups/public/org/apache/mahout/mahout-distribution/0.8/* .
    • rm -rf repository.apache.org/
    • rm index.html
  • Wait 24 hours for release to propagate to mirrors.
  • Clean up JIRA: Bulk close all X.Y JIRA issues. Mark the Version number as being released (see Manage Versions.) Add the next version (X.Y+1) if necessary.
  • Update release version on http://mahout.apache.org/ and http://en.wikipedia.org/wiki/Apache_Mahout * https://cwiki.apache.org/confluence/display/MAHOUT/How+To+Update+The+Website
  • Send announcements to the user and developer lists.

See also:

  • http://maven.apache.org/developers/release/releasing.html * http://www.sonatype.com/books/nexus-book/reference/staging-sect-deployment.html
  • http://www.sonatype.com/books/nexus-book/reference/index.html

Post Release

Versioning

  • Create the next version in JIRA (if it doesn't already exist)
  • Mark the version as "released" in JIRA (noting the release date)

Documentation

  • Change wiki to match current best practices (remove/change deprecations, etc)

Publicity

  • update freshmeat
  • blog away
  • Update MLOSS entry: http://mloss.org/revision/view/387/. See Grant for details.
  • http://www.apache.org/dev/#releases
  • http://www.apache.org/dev/#mirror

TODO: Things To Cleanup in this document

  • more specifics about things to test before starting or after packaging (RAT, run scripts against example, etc...)
  • include info about [Voting | http://www.apache.org/foundation/voting.html#ReleaseVotes]