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. Update the distribution README file:
    1. Commit the changes
  8. Create a copy of the test plan template and review it
  9. Execute a complete test (it takes several hours). Replace TestPReffix by OntoNotes4|ConllL2002|ConllX|Arvores|Conll00

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

  10. Do a trial build with:

  11. Checkout the apache master
  12. Execute release prepare:

  13. Answer all questions
  14. If it finished with success, do a release perform

  15. (this will create a X.Y.Z release tag in GIT that you can use for VOTE'ing in your VOTE email. 
  16. 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).
  17. The build results is in opennlp/target/checkout/target/
  18. Perform basic check in the release binary (signature, presence of license, issues folder, execute the CLI)
  19. Upload the deliverables to your "" repository using SFTP
    1. Connect to the server using your apache credentials
    2. Create a folder named public_html/releases/opennlp-<VERSION>/rc1 for you (change VERSION and rc1 according to the correct values)
    3. Upload these files to the remote RC folder: opennlp/target/checkout/target/apache-opennlp*
    4. Upload README and RELEASE_NOTES.html
    5. Upload issuesFixed folder
  20. If VOTE passes with 3+ OpenNLP PMC votes, move onto next step. If VOTE does not pass, repeat steps 5-on until it does.
  21. Close the successful release vote
  22. Promote the nexus staging repo
  23. SNV the distribution to


  24. Update the web site: distribution, maven dependency version, documentation. Wait for 26 to finish to promete the website changes.
  25. Wait for versions to hit the mirrors (hint: keep checking until you see something).
  26. Promote the website changes.
  27. 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.