Add a section on preparing to release to the README.

Why is this change needed? -------------------------- The README assumed that you already had the public maven repo and gpg correctly configured. How does it address the issue? ------------------------------ Gives instructions to install and generate proper keys, and indicates who has repo authority in case your credentials are not sufficient. Any links to any relevant tickets, articles or other resources? --------------------------------------------------------------- Co-authored-by: Joel Meador <[email protected]> Co-authored-by: Matthew Gordon <[email protected]>
Instrumental · May 21, 2019 · 7ba7526 · 7ba7526
1 parent 3ec4cff
commit 7ba7526
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -84,6 +84,34 @@ We are here to help. Email us at [[email protected]](mailto:support@in
 13. Use the git tag and make a new release with `target/instrumental_agent-*` attached, https://github.com/instrumental/instrumental_agent-java/tags
 14. Refresh documentation on instrumentalapp.com
 
+## If you have never released before
+
+Somewhere around the gpg step in the release process, things will break unless you have all the right bits twiddled:
+
+1. Install gnupg `brew install gnupg`
+1. If you don't have a key in gpg, `gpg --gen-key`
+1. Look at your key `gpg --list-secret-keys`
+1. Send that key to ubuntu using the ID from the previous step: `gpg --keyserver hkp://keyserver.ubuntu.com:80 --send-keys YOURKEYIDGOESHERE`
+1. Create a settings.xml file in ~/.m2/settings.xml that looks like this:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
+
+  <servers>
+    <server>
+      <id>ossrh</id>
+      <username>YOURUSERNAMEHERE</username>
+      <password>YOURPASSWORDHERE</password>
+    </server>
+  </servers>
+</settings>
+```
+
+After doing all this, if you get an error indicating that your credentials are not working, talk to @esquivalient.
+
 
 ## Version Policy