Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Release HOW TO Maintenance

Info
titleBefore you begin...

It has become tradition for the Release Manager (RM) to take due care to ensure that this release management HOW TO us kept accurate.

If you fulfill the role of Release Manager, please take the time to carefully review, update, remove, or edit this documentation such that it remains a canonical, reproducible resource for the Nutch community.

Thank you (smile) 


Prerequisites

  • Apache Maven (most recent stable release)
  • Apache Ant (most recent stable release)
  • apache-release profile present in your local ~/.m2/settings.xml. An example can be found below N.B. It is important that you pay close attention to the contents of this file. Numerous issues now exist with the ant-maven-task plugin so a couple of workarounds exist in this guide.

...

In the instance where the VOTE does not pass, the release manager should roll back all of the work above as well as DROP the staging artifacts.

Making the

...

release

  1. head back over to the staging repos and RELEASE them into the wild.

  2. Move the artifacts from the release management area to the release area as follows:

    svn mv https://dist.apache.org/repos/dist/dev/nutch/$release.version https://dist.apache.org/repos/dist/release/nutch/$release.version --message "Release Apache Nutch $release.version" 
  3. wait until the release is visible on the release page
  4. update the Nutch website (see nutch-site README how to)
    1. add the new release info to the doap.rdf file (content/doap.rdf), 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
    2. replace the folder content/documentation/javadoc/apidocs/ with the Java API doc folder of the current version
    3. (only if generating the Miredot REST API docs succeeded) copy the Miredot REST API doc folder (remember this can be located in $NUTCH_HOME/target/miredot) into the nutch-site directory cms_site/content/miredot/

    4. update the version numbers on the javadoc page (content/documentation/javadoc/index.md) and the wiki FrontPage

    5. update the links to release packages on the downloads page (content/download.md)
    6. write a short announcement about the new release in the news section (content/news/)

    7. build the Nutch website, verify the changes and deploy the site
  5. Release the version on Jira
  6. (if necessary) prepare announcements regarding CVEs resolved with this release of Nutch, see the Apache security howtos
  7. Send announcements to the user and developer lists as well as announce@apache.org

  8. Finally, don't forget to remove the previous release from dist.apache.org to reduce the load on ASF mirrors, see when-to-archive and NUTCH-1742.

...

  1. Update version numbers to A.B-dev (assuming A.B is next release number) 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"

  2. Update CHANGES.md with header for new changes.
  3. Ensure that a new version in JIRA exists for development snapshots (A.B-dev). If this is not there then create one.

...