[CONF] Apache Lucene Mahout > How to release

[co...@apache.org]

Space: Apache Lucene Mahout (http://cwiki.apache.org/confluence/display/MAHOUT)
Page: How to release (http://cwiki.apache.org/confluence/display/MAHOUT/How+to+release)


Edited by Sean Owen:
---------------------------------------------------------------------
This wiki page is under contruction, currently more or less a modified clone of the Solr HowToRelase page. More to come soon!

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

h1. Release Planning

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

 * Any [unresolved Jira issues with the upcoming version number listed as the "Fix Version" | https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&&pid=12310751&fixfor=12312976&resolution=-1&sorter/field=issuekey&sorter/order=DESC]
 * Any ["Fixed" Jira issues missing a "Fix Version" | https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&&pid=12310751&fixfor=-1&resolution=1&sorter/field=issuekey&sorter/order=DESC] that should be updated to indicate that there were fixed in this upcoming version?
 * Does any documentation needs an updated?  Any necessary notes on upgrading for CHANGES.txt?
 * Who is going to be the "release engineer"?
 * What day should be targeted for the release ?  (leave buffer time for a code freeze and release candidate testing; make sure at least a few people commit to having time to help test the release candidates around the target date.)


h1. 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

h1. Steps For Release Engineer

h2. Before building release
 # Check that all tests pass after a clean compile: mvn clean test
 # Double Check that there are no remaining unresolved Jira issues with the upcoming version number listed as the "Fix" version
 # Double Check that there are no ["Fixed" Jira issues missing a "Fix Version" | https://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12312765] that should be marked as fixed in this release.
 # Publish any prev. unpublished Third Party Deps: [ThirdPartyDependencies]

h2. Making a release
 # Check if documentation needs an update
 # Update news in {{src/site/src/documentation/content/xdocs/index.xml}} and for main lucene.apache.org site stored at https://svn.apache.org/repos/asf/lucene/site/. The second change may require additional rights or  patch submitted to the Lucene PMC
 # Commit these changes.
           '''Note:''' 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 in Subversion at https://svn.apache.org/repos/asf/lucene/mahout/trunk/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 : http://maven.apache.org/developers/committer-settings.html
 # Add a profile to your ~/.m2/settings.xml in the <profiles> section with:
     {quote}
<profile>
      <id>mahout_release</id>
      <properties>
        <gpg.keyname>YOUR PGP KEY NAME</gpg.keyname>
        <gpg.passphrase>YOUR SIGNING PASSCODE HERE</gpg.passphrase>
        <deploy.altRepository>mahout.releases::default:: https://repository.apache.org/service/local/staging/deploy/maven2/</deploy.altRepository>
        <username>USERNAME</username>
        <deploy.url> https://repository.apache.org/service/local/staging/deploy/maven2/</deploy.url>
      </properties>
    </profile>
{quote}
 and in the <servers> section, add
{quote}
 <server>
       <id>apache.releases.https</id>
       <username>ASF SVN username</username>
       <password>ASF SVN password</password>
     </server>
{quote}
 # Set environment variable MAVEN_OPTS to -Xmx1024m to ensure the tests can run
 # If this is the first release in a series (i.e. relase X.Y.0):
    # Prepare the release (actually, will prepare a Release Candidate)
		 {{mvn -Prelease,mahout_release release:prepare}}
    # Perform the release (copies the release candidate to staging area)
                 {{mvn -Prelease,mahout_release release:perform}}       
    # *IF it screws up, do not clean or release:clean without first trying to do: release:rollback.  This will likely save you time and do the right thing.  If it doesn't work, then do clean and release:clean and also delete the tag from svn, if it was created.  *
    # *NOTE: You may also have to rollback the version numbers in the POM files*
    # 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.
       ## Login into Nexus
       ## Click the Repositories link in the left hand menu
       ## Click the "User Managed Repositories" in the navbar just below the "Welcome" tab
       ## Choose "Nexus Managed Repositories" instead of "User Managed"
       ## Find and click the Mahout staged one that was just uploaded by the release:perform target
       ## In the middle frame, select Mahout and right click and choose Close.  See http://maven.apache.org/developers/release/releasing.html for a picture
       ## Copy the "Repository URL" link to your email
    # Ask others on mahout-dev to review the artifacts.
    # Call a VOTE on mahout-dev@ and CC general@lucene.apache.org.  Votes require 3 days before passing.  See Apache [release policy|http://www.apache.org/foundation/voting.html#ReleaseVotes] for more info.
    # If the vote passes, then promote the artifacts in the Nexus Repository to the appropriate mirrors and repositories.  *TODO: Fill in more here*
    # Copy the Assemblies (tar.gz, zip, tar.bz2) to the ASF mirrors at: people.apache.org:/www/www.apache.org/dist/lucene/mahout/. 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.
    # Wait 24 hours for release to propagate to mirrors.
    # Deploy new Mahout site.
    # Deploy new main Lucene site.
    # Update Javadoc in {{people.apache.org:/www/lucene.apache.org/mahout/docs/api}}.
           NOTE: skip this for now, as this javadoc is currently updated automatically from the nightly build
    # 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.
    # 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

h2. Post Release
h3. Versioning
 * Create the next version in Jira (if it doesn't already exist)   
 * Mark the version as "released" in Jira (noting the release date)

h3. Documentation
 * Change wiki to match current best practices (remove/change deprecations, etc)

h3. Publicity
 * update freshmeat
 * !TheServerSide blurb
 * blog away
 * Update MLOSS entry: http://mloss.org/revision/view/387/.  See Grant for details.


h1. Related Resources

 * http://www.apache.org/dev/#releases
 * http://www.apache.org/dev/#mirror

h1. :TODO: Things To Cleanup in this document

*TODO*

 * more info about the process (ie: stage the release candidate on people.apache.org, send email to mahout-dev seeking feedback, etc...) 
 * 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]


Change your notification preferences: http://cwiki.apache.org/confluence/users/viewnotifications.action