Release HOWTO

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

Making a release.

1. Update version numbers (from X.Y-dev to X.Y) for release in:

   • nutch-default.xml - user agent string

   • default.properties - version property

2. Update CHANGES.txt with release date and (if needed) add additional changelog entries.

3. Check if documentation needs an update.

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

5. Commit all these changes.

6. Make a clean checkout.

   • svn co https://svn.apache.org/repos/asf/lucene/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/lucene/nutch/trunk \ https://svn.apache.org/repos/asf/lucene/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/lucene/nutch/dist/KEYS (update site @minotaur /www/www.apache.org/dist/lucene/nutch svn up)

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

14. Wait 24 hours for release to propagate to mirrors.

15. Deploy new Nutch site (according to Website Update HOWTO).

16. Deploy new main Lucene site (according to Website Update HOWTO but modified for Lucene site - update is to be performed in /www/lucene.apache.org directory).

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

18. Create version in JIRA for release X.Y.

19. 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/lucene/nutch/tags/release-X.Y \  https://svn.apache.org/repos/asf/lucene/nutch/branches/branch-X.Y \ -m "Nutch X.Y release maintenance branch." 

2. Update version numbers for to A.B-dev (assuming A.B is next release number) in:

   • nutch-default.xml - user agent string

   • default.properties

3. Update CHANGES.txt with header for new changes.

4. Create version in JIRA for development snapshots (A.B-dev).