From 031f5b553bd9d29f21bcce971f6544e61d0deff7 Mon Sep 17 00:00:00 2001 From: James Moger Date: Mon, 4 Apr 2016 21:04:38 -0400 Subject: [PATCH] Documentation --- README.markdown => README.md | 0 RELEASE.md | 53 ++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) rename README.markdown => README.md (100%) create mode 100644 RELEASE.md diff --git a/README.markdown b/README.md similarity index 100% rename from README.markdown rename to README.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..5c05e03 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,53 @@ +## Releasing + +These are quick notes on using Maven to release artifacts to Sonatype. + +### Snapshots + +To release a snapshot to [Sonatype OSS Snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/): + + mvn clean deploy + +### Releases + +Releases are deployed to [Sonatype OSSRH Staging](http://central.sonatype.org/pages/releasing-the-deployment.html) and then manually synced to Central. + +To release with automated versioning and SCM integration: + + mvn release:clean release:prepare + mvn release:perform + +To release manually: + + mvn versions:set -DnewVersion=1.2.3 + mvn clean deploy -P release + +### Settings.xml + +Sonatype uploads are authenticated and require credentials. +GPG signing requires a passphrase to unlock the signing key. +Both of these secrets can be stored in `~/.m2/settings.xml`. + +```xml + + + + ossrh + jira-username + jira-password + + + + + ossrh + + true + + + gpg + gpg-password + + + + +``` -- 2.39.5