Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.43 KB

RELEASE.md

File metadata and controls

51 lines (40 loc) · 1.43 KB

How to release to Maven Central

  • Follow Central recommendations for setting up Apache Maven
  • Ensure GPG is set up for signing jars
  • Ensure ~/.m2/settings.xml has the following contents for signing and uploading jars to Maven Central
<settings>
  <servers>
    <server>
      <id>sonatype-nexus-staging</id>
      <username>[OSS_USER]</username>
      <password>[OSS_PASSWORD]</password>
    </server>
  </servers>
</settings>

Prepare for release checklist

[ ] Run unit testing and check test coverage

[ ] Ensure Javadoc API is fully documented

[ ] Update README.md for release

Perform release

  1. Increment the version in pom.xml to a stable release: e.g. 0.7. Commit.
  2. Tag the current commit: e.g. 0.7.
  3. Upload the release.
    mvn -e clean deploy -P sonatype-oss-release
    
  4. Increment plugin version to next snapshot: e.g. 0.8-SNAPSHOT. Commit.
  5. Push commits and tags
    git push origin && git push --tags origin
    

This will initially upload the artifact to a staging repository. Once confident about the release visit Maven Central Nexus and follow instructions on releasing to production.