Child pages
  • Release Process
Skip to end of metadata
Go to start of metadata

This page documents the Apache OpenNLP release process.

Step-by-step guide

  1. Elect a release manager
  2. Create a new release in JIRA. If you do not have permissions to do so just ask to be assigned privileges on the mailing list.
  3. Review the JIRA issues associated to the release.
  4. 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.
  5. Make sure you have your PGP key entered into
    1. Your KEYS will then be present in:
  6. Check if you have your PGP keys password.
  7. Checkout the apache master

  8. Execute a complete test (it takes several hours).

    Merge no source code changes after running the tests, or we will need to rerun it.

  9. Do a trial build with:

  10. Execute release prepare:

  11. Answer all questions
  12. If it finished with success, do a release perform

  13. (this will create a X.Y.Z release tag in GIT that you can use for VOTE'ing in your VOTE email. 
  14. It will also create a staged repository at Check the staged repository and if all looks well, close the repository, but don't release it yet).
  15. The build results is in opennlp/target/checkout/target/
  16. Perform basic check in the release binary (signature, presence of license, issues folder, execute the CLI)
  17. If VOTE passes with 3+ OpenNLP PMC votes, move onto next step. If VOTE does not pass, repeat steps 5-on until it does.
  18. Close the successful release vote
  19. Promote the nexus staging repo
  20. SNV the distribution to


  21. Update the web site: distribution, maven dependency version, documentation. Wait to merge the changes uptil the new versions apeear in the Apache download mirrors.
    1. Add a new artifactItem in the pom.xml for the new OpenNLP release. (This automatically pulls in the details and javadocs for the new version when the site is built.)
    2. Move the last version's links to the documentation to the Legal Documentation page.
    3. Update the doap_opennlp.rdf file to reflect the new version.
  22. Wait for versions to hit the mirrors (hint: keep checking until you see something).
  23. Promote the website changes.
  24. Log the new version at
  25. Announce the new version on the OpenNLP Twitter.
  26. Send announcement email to announce@a.o and dev@opennlp.a.o and user@opennlp.a.o. This needs to be done from your email address or the email will bounce from the announce list. Gmail forwarding can help here and is a snap to set up ( It's even easier then the instructions there as it will recognize your email address and default to Apache settings. It is important to include a description of what OpenNLP is as well as a link to the updated DOAP within the release announcement, this is so others know what OpenNLP is.