summaryrefslogtreecommitdiff
path: root/RELEASING.md
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2015-03-06 09:36:52 -0800
committerJesse Morgan <morganjm@amazon.com>2015-03-06 09:36:52 -0800
commitf14d8fc7de0f49dc66d5a2871d5141f5c679a2b2 (patch)
tree22585844329e2a537c616257a7a68dc3629459c4 /RELEASING.md
parent13f58b778c5559b24f1b371cfb54ad80a5ba4b3f (diff)
parentbb5b9878e8a9e96161dea08b077258568bb66425 (diff)
Merge branch 'master' into v1.3v1.3.1
Conflicts: pom.xml
Diffstat (limited to 'RELEASING.md')
-rw-r--r--RELEASING.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..a7ddd36
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,46 @@
+RELEASING
+=========
+
+This file outlines how to publish a new release to Maven Central.
+
+Prerequisites
+-------------
+
+* You will need the Carbonado GPG key and passphrase to continue. Contact
+ @jesterpm or @pranaydalmia to obtain them.
+
+* You will need an account with Sonatype Nexus. You can create that
+ [here](https://issues.sonatype.org/secure/Signup!default.jspa). Contact
+ @jesterpm or @pranaydalmia for access to the Carbonado repository.
+
+Process
+-------
+
+1. Increment the version number appropriately.
+ Use [Semantic Versioning](http://semver.org/).
+
+ VERSION=1.2.4
+ mvn versions:set -DnewVersion=$VERSION
+
+2. Verify the release and make sure all is well.
+
+ mvn clean verify -P release
+
+3. Commit and tag the latest release.
+
+ git commit -am "Release $VERSION"
+ git tag -a v$VERSION -m "Release $VERSION"
+
+4. Deploy to Sonatype:
+
+ mvn clean deploy -P release
+
+5. Push commit and tag to GitHub
+
+ git push origin master
+ git push origin v$VERSION
+
+6. Create a new Releases on GitHub. Use the tag you just created and optionally
+ include a change log. Attach the compiled, sources, and javadoc jar files,
+ along with the .asc signature files.
+