summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJesse Morgan <jesse@jesterpm.net>2016-04-09 12:36:39 -0700
committerJesse Morgan <jesse@jesterpm.net>2016-04-09 12:36:39 -0700
commitebd41d26884f4a8e9247ea4b2439c4c367e68775 (patch)
tree57b5a36bc078898f4caff8413e119cab0ba5360d
parenta3c12f8a8b29ba706167370846efce5274005e3f (diff)
Adding release instructions so I don't forget later.
-rw-r--r--RELEASING.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000..eca79d8
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,41 @@
+RELEASING
+=========
+
+These instructions serve as a reminder on how to release to Maven Central.
+
+Process
+-------
+
+1. Increment the version number appropriately. Use [Semantic Versioning](http://semver.org/).
+
+ VERSION=1.1
+ mvn versions:set -DnewVersion=$VERSION
+
+2. Verify the release to 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.
+
+7. Prepare the master branch for the next release by incrementing the version number.
+
+ VERSION=1.2-SNAPSHOT
+ mvn versions:set -DnewVersion=$VERSION
+ git commit -am "Incrementing the version to $VERSION"
+ git push origin master