- Put your repository credentials in your Maven settings.xml file for both snapshot and staging repositories in pom.xml.
- Put your gpg certificate credentials in the settings.xml file
- Snapshot releases may be deployed using
mvn clean deploy- The version number in the pom.xml must end in -SNAPSHOT
- Make sure tests are green on Travis CI.
- Review SonarQube for any bugs.
- Run
mvn clean teston every OS you have access to - Choose an appropriate version number for the release
- Proactively change version numbers in the download links on README.md.
- Copy README.md to src/site/markdown/README.md
- HTML-escape
&,<, and>in any links in the site version
- HTML-escape
- Change "Next" or in-progress version in CHANGELOG.md to this new version.
- Move "Your contribution here." to a new empty "Next" section
- Commit changes as a "prep for x.x release"
-
See this page for a summary of the below steps
-
mvn clean deploy- Do a final snapshot release and fix any errors in the javadocs
- If license headers are rewritten as part of this deployment, commit the changes
-
mvn release:clean- Takes a few seconds
-
mvn release:prepare- Takes a few minutes
- This will ask for the version being released, removing -SNAPSHOT
- This will suggest the next version, increment appropriately
-
mvn release:perform -
Log on to Nexus and release the deployment from OSSRH to the Central Repository.
-
Add a title and release notes to the tag on GitHub and publish the release to make it current.
-
As development progresses, update version in pom.xml using -SNAPSHOT appended to the new version using Semantic Versioning standards:
- Increment major version (x.0) for API-breaking changes or additions
- Increment minor version (x.1) for substantive additions, bugfixes and changes that are backwards compatible
- Increment patch version (x.x.1) for minor bugfixes or changes that are backwards compatible