Introduction

This page is prepared and maintained for/by Nutch committers. You need committer rights to create a new Nutch release.

Preparation

  1. Create a new release in JIRA. If you do not already have these privileges ask your PMC Chair.
  2. Push off all open issues to the next release; any critical or blocker issues should be resolved on mailing list. Discuss any issues that you are unsure of on the mailing list.

Making the Release

  1. Update version numbers (from X.Y-dev to X.Y) for release in:
    • nutch-default.xml - http.agent.version property
    • default.properties - version property and year property
  2. Update CHANGES.txt with release date and (if needed) add additional changelog entries.
  3. Check if documentation needs an update. Although this may be a huge task at any given time, any minor contribution is better than nothing at all.
  4. Update news in https://svn.apache.org/repos/asf/nutch/site//site/forrest/src/documentation/content/xdocs/index.xml and for the main nutch.apache,org site stored here. There is documentation on how to edit, manage and build the site documentation here

  5. Commit all these changes.
  6. Make a clean checkout.
    • svn co https://svn.apache.org/repos/asf/nutch/trunk/.

  7. Build it.
    • ant tar

  8. Run unit tests.
    • ant test

  9. Do basic test to see if release looks ok - e.g. install it and run example from tutorial.
  10. Tag it.
    • svn copy https://svn.apache.org/repos/asf/nutch/trunk/  https://svn.apache.org/repos/asf/nutch/tags/release-X.Y -m "Nutch X.Y release." 

  11. Sign it - Step-By-Step Guide to Mirroring Releases.

  12. Make sure your pgp key is listed in https://svn.apache.org/repos/asf/nutch/tags/release-X.Y/KEYS (update site @minotaur /www/www.apache.org/tags/nutch svn up)

  13. Copy release tar file to people.apache.org:/www/www.apache.org/tags/nutch.

  14. Wait 24 hours for release to propagate to mirrors.
  15. Add the new release info to the doap.rdf file, and double check for any other updates that should be made to the doap file as well if it hasn't been updated in a while. If this is the case please see here

  16. Deploy new Nutch site (according to Website_Update_HOWTO).

  17. Update Javadoc in people.apache.org:/www/nutch.apache.org/apidocs.

  18. Send announcements to the user and developer lists.

Preparing for new development

  1. If needed create a branch for release maintenance(can be done when first commit to branch would be needed).
    •  svn copy https://svn.apache.org/repos/asf/nutch/tags/release-X.Y \  https://svn.apache.org/repos/asf/nutch/branches/branch-X.Y \ -m "Nutch X.Y release maintenance branch." 

  2. Update version numbers to A.B-dev (assuming A.B is next release number) in:
    • nutch-default.xml - http.agent.version property
    • default.properties - version property and year property
  3. Update CHANGES.txt with header for new changes.
  4. Ensure that a new version in JIRA exists for development snapshots (A.B-dev). If this is not there then create one.

Good Luck :)

<<<FrontPage

Release_HOWTO (last edited 2012-04-03 14:22:06 by LewisJohnMcgibbney)