add release document

ctron · Aug 18, 2016 · 3d7fdac · 3d7fdac
1 parent c8b5f3a
commit 3d7fdac
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,28 @@
+# Performing a release
+
+This is my cheat sheet for doing a release.
+
+## Prepare
+
+Ensure that `.m2/settings.xml` contains the GitHub credentials:
+
+    <server>
+      <id>github</id>
+      <password><!-- access key --></password>
+    </server>
+
+## Do the release
+
+    mvn release:clean release:prepare release:perform
+
+## Maven Central
+
+Head over to https://oss.sonatype.org/ and do the release
+
+## Upload the documentation
+
+    git checkout <tag>
+    # prepare and maybe modify site.xml
+    mvn site -Ppages
+    git checkout master
+