Tika release process

Before the release

Consider running mvn versions:display-plugin-updates and mvn versions:display-dependency-updates to identify any updates that need to be made. Make sure to run full regression tests after making updates.

Making a release

If you've done this before, have all programs installed, all necessary karma granted, and everything configured, steps 1 though 9 will take around an hour (tests take a while to run). If you've never done this before, you will probably run into an issue not covered in this set of instructions. So, it will take longer (maybe a couple hours, maybe a couple days).

Either way, please update these instructions with any clarifications you think might help the next release manager.

  1. git clone https://github.com/apache/tika.git release

  2. Update CHANGES.txt with release date (Release X.Y - MM/dd/yyyy (date format matters!) and (if needed) add additional changelog entries.
  3. On the Tika JIRA, create versions X.Y, X.(Y+1), and X.(Y+2), if not already done.
    1. Move any lingering unresolved issues from X.Y to X.(Y+1).
      1. Query open issues: e.g. "project = Tika AND resolution = unresolved AND fixVersion = 1.16"
      2. Upper right, select bulk change
      3. Select all, modify to fixVersion = X.(Y+1)
      4. At the bottom of the screen, unselect the email updates
  4. git add CHANGES.txt && git commit -m "Update CHANGES.txt for X.Y release." && git push origin

  5. Run apache-rat:check and fix any missing license headers / add excluded for properly non-licensed fails

  6. setenv MAVEN_OPTS "-Xms128m -Xmx256m" (or export MAVEN_OPTS="-Xms128m -Xmx256m" if you are using bash)

  7. mvn release:prepare

    1. Make sure all the release numbers are set to X.Y (from X.Y-SNAPSHOT)
    2. When prompted, the scm tag name should be X.Y (version number). If this is a release candidate, the tag should be X.Y-rcN.
    3. Watch for a BUILD SUCCESSFUL message

    4. Make sure you have gnupg (or variant) installed (see http://www.apache.org/dev/openpgp.html)

  8. mvn release:perform

    1. Make sure you can log on to https://repository.apache.org/

    2. Make sure you have the following entry in your ~/.m2/settings.xml file: http://maven.apache.org/settings.html#Servers. The server ID should be apache.releases.https.

  9. Head over to https://repository.apache.org/ (Apache's Nexus Server)

    1. Login with your ASF username and password
    2. Make sure there is only one repo from your build and that it contains everything. A transmission failure can lead to multiple repositories, none of which are valid...even when mvn release:perform alleges SUCCESS

    3. "Close" the staging repository with message Apache Tika X.Y release candidate #N.

    4. Copy the URL from the closed staged repository for Tika (you'll need this later)
  10. Update CHANGES.txt with a "Release X.Y + 1 - Current Development" section.
  11. Check the contents of target/checkout/target/X.Y/* into https://dist.apache.org/repos/dist/dev/tika/ (tika-X.Y-src.zip{.asc|.md5|.sha}, tika-app-X.Y.jar{.asc|.md5|.sha} and tika-server-X.Y.jar{.asc|.md5|.sha}, and CHANGES.txt.

    1. svn co https://dist.apache.org/repos/dist/dev/tika/ dist.dev.tika

    2. cd dist.dev.tika

    3. svn rm ./tika* (remove everything but the KEYS file)

    4. cp ../release/target/checkout/target/X.Y/* .

    5. mv CHANGES.txt CHANGES-X.Y.txt

    6. cp KEYS . -- if it isn't there already copy the KEYS file to go along with the jars and other release artifacts; add your key to KEYS if you haven't already

    7. svn add ./*

    8. svn commit -m "Add Tika X.Y RC#N artifacts."

    9. See the file in target/checkout/target/vote.txt - it contains the contents of the release email you should send (with subject [VOTE] Apache Tika X.Y Release Candidate N to dev@tika.apache.org and to user@tika.apache.org). Ensure all URLs are correct and update the email to include links to the artifacts from #8 (including .sha, .md5 and .asc and CHANGES.txt)

    • If the VOTE passes:
      1. Send [RESULT] [VOTE] tallying the VOTE to dev@tika.apache.org and user@tika.apache.org

      2. Head over to Nexus from #6 and "Release" the repository with message Apache Tika X.Y release (and make sure the box is checked to auto drop).
      3. svn rm https://dist.apache.org/repos/dist/release/tika/*

      4. svn mv https://dist.apache.org/repos/dist/dev/tika/* https://dist.apache.org/repos/dist/release/tika/

      5. git clone https://github.com/apache/tika.git X.Y-rcN

      6. Add final tag for the release and delete the X.Y-rcN tag
        1. Look up commit for X.Y-rcN commit: git show-ref --abbrev=7 --tags; let's say 'd831efb'

        2. git tag -a X.Y d831efb -m "Tagging X.Y release"

        3. git tag -d X.Y-rcN

        4. git push --tags

        5. git push origin :refs/tags/X.Y-rcN

    • Else:
      1. Drop the new Tika staging repository on repository.apache.org.
      2. Make an entry in CHANGES.txt which documents the subsequent changes between release candidates. This is extremely useful if the candidates are cut from master and master has moved on since the release candidate was originally cut.
      3. Go back to #1.
  12. Update the version of any unreleased modules (like tika-dotnet).
  13. Update Tika site.
    1. Update parent version number in the site pom.xml file.
    2. Update the Documentation section of src/site/site.xml. Make sure to add the collapse tag for the now old version.
    3. Update the "Full List of Supported Formats" section of the formats page of version X.Y using TIKA-411; e.g. java -jar ../master/tika-app/target/tika-app-1.15.jar --list-parser-details-apt >> src/site/apt/1.15/formats.apt

    4. Update the version number in the dependency examples and the commandline options in the new X.Y src/site/apt/X.Y/gettingstarted.apt page
    5. Update src/site/resources/doap.rdf with the new release.
    6. Create a new example and formats page (truncated to where step 15.3 should go next time) for the next version (but don't list it in the sidebar).
    7. Update index.apt.vm to include the announcement.
    8. Update index.apt
      1. Generate the contributor list with https://github.com/chrismattmann/apachestuff/blob/master/extract-tika-contribs

      2. Generate the issues list by running https://github.com/chrismattmann/apachestuff/blob/master/extract-tika-issues.py against CHANGES.txt.

      3. Update the link to the JIRA query (e.g. https://s.apache.org/XowY) via Apache's shortening service https://s.apache.org

    9. Generate the Javadoc.
      1. cd master

      2. mvn javadoc:aggregate

      3. mv target/site/apidocs /tika/site/publish/X.Y/api

    10. Update tika-server documentation:
      1. mvn -Pserver install in the tika-server module to build the miredot documentation

      2. rm -r /tika/site/src/site/resources/X.Y/miredot

      3. cp /tika/master/tika-server/target/miredot /tika/site/src/site/resources/X.Y

    11. Check everything looks good with mvn site:run.

    12. mvn clean install

    13. svn add <any files changed for site> (probably: src/site/apt/X.Y and src/site/resources/X.Y/miredot) && svn commit -m "Update website for X.Y release."

    14. On the Tika JIRA, "release" version X.Y and update any (new) straggler X.Y issues to X.(Y+1).
    15. Send announcements to user@tika.apache.org, dev@tika.apache.org, and announce@apache.org lists (from your Apache email) - see http://s.apache.org/2hC for a sample. If resending an earlier email, but edited, make sure that you use text format and/or make sure that editing the links updates the underlying links and not just the anchor text. NOTE FOR THE 1.18/2.0 RELEASE and subsequent releases:

      1. Change these lines: Apache Tika is available in source form from the following download page: http://www.apache.org/dyn/closer.cgi/tika/apache-tika-1.6-src.zip to Apache Tika is available on the download page: http://tika.apache.org/download.html

      2. Change the link to the keys from https://people.apache.org/keys/group/tika.asc to https://www.apache.org/dist/tika/KEYS

      3. After sending the announcement, update the shortened url above for this new sample!
  14. Log on to https://reporter.apache.org/addrelease.html?tika and add the release data (version and date) to the database

NOTE: if anything goes wrong during mvn:release-prepare or mvn release:perform:

  1. mvn:release-clean

  2. Undo any commits that changed the version number
  3. Delete the X.Y-rcN tag: git push --delete origin X.Y-rcN && git tag --delete X.Y-rcN

After the release, consider making a PR to make the upgrade in Apache Solr. See UpgradingTikaInSolr.

After the release, announce any CVEs that were fixed and update Security.apt and republish the site.

ReleaseProcess (last edited 2018-10-17 13:49:02 by TimothyAllison)