Page History

...

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.
3. Create a branch branch-x.x, from now on, use the branch created above.
4. Update version numbers (from X.Y-SNAPSHOT to X.Y) for release in:
   • conf/nutch-default.xml - http.agent.version property
   • default.properties - version property and year property

   • src/bin/nutch - version number in echo "nutch X.Y"

5. in default.properties update the links to Javadocs of important dependencies (eg. Hadoop)
6. Update CHANGES.md with release date and (if needed) add additional changelog entries (from Jira Report). It's also good practice to include a link to the Jira report.
7. 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.
8. Commit all these changes to the branch you are releasing.

9. To avoid that "forgotten" files in your development environment are packaged, make a clean checkout for the release branch or tag:

   • cd ...
     git clone --branch branch-x.x https://github.com/apache/nutch.git branch-x.x
     cd branch-x.x

10. Run unit tests.
    ant test

    1. ant test

11. If successful, also run the long-running tests including the integration tests for the indexers (Solr, Elasticsearch, Kafka, RabbitMQ).

    1. ant test-full test-index-integration

12. Build the binary package

    ant tar-bin

13. Do basic test to see if release looks ok - e.g. install it and run example from tutorial.

14. Run the docker container

15. Get hold of the most recent version of maven-ant-tasks-2.X.X.jar and put it in the $NUTCH_HOME/ivy directory

16. Set the ${MVN_HOME} environment variable on the machine you are executing the release from. This must point to the Apache Maven home directory.
17. Ensure you have an apache-release profile in your local ~/.m2/settings.xml as detailed in the prerequisites above
18. Set the ${MAVEN_GPG_PASSPHRASE} environment variable on the machine you are executing the release from. This must be the GPG passphrase associated with the key you are using to sign the release artifacts.

19. Execute ant -lib ivy deploy from $NUTCH_HOME, this will sign the Maven artifacts (sources, javadoc, .jar) and send them to a Apache Nexus staging repository. Details of how to set this up can be found here. N.B. Ensure that you have an apache-release profile contained within ~/.m2/settings.xml

20. Once you've read, and are happy with the staging repository, close it.

21. Remove the following artifacts
    • $NUTCH_HOME/ivy/maven-ant-tasks-2.X.X.jar
    • $NUTCH_HOME/pom.xml
    • $NUTCH_HOME/pom.xml.asc
    • $NUTCH_HOME/target
22. Tag the release candidate.

    • git tag -a release-X -m "Apache Nutch X RC#X Tag"

23. Push it to the remote host.

    • git push origin release-X

24. Run the packaging tasks. The generated artifacts can be found in $NUTCH_HOME/dist. If you experience issues during this stage you may need to prune/delete ~/.ivy2/cache/*

    1. ant zip-bin && ant tar-bin && ant zip-src && ant tar-src

25. Check out the release management area, create a new directory for the release and copy CHANGES.md there

    1. svn co https://dist.apache.org/repos/dist/dev/nutch/ nutch_staging
       
    2. mkdir nutch_staging/${release_version}
    3. cp CHANGES.md nutch_staging/${release_version}
26. Sign all of the generated artifacts - Step-By-Step Guide to Signing Releases. After the signing each release package must be accompanied by the *.asc and the *.sha512 signature file.
27. Copy all of the release artifacts to the staging directory and commit to the SVN server
    1. cp $NUTCH_HOME/dist/*.tar.gz* $NUTCH_HOME/dist/*.zip* nutch_staging/${release_version}/
    2. svn add nutch_staging/${release_version}
       
    3. svn ci -m "Stage Apache Nutch ${release_version}  RC#1"

28. Make sure your pgp key is listed in the Nutch KEYS file located at http://www.apache.org/dist/nutch/KEYS or better yet, use https://id.apache.org/ and add your PGP there, and it will then appear in Apache Nutch's Automatically Generated Keys

29. Create and open a VOTE thread on user@ and dev@nutch.apache.org. The VOTE must pass with 3 +1 binding VOTE's before any release can take place. A VOTE thread usually takes the form

...