Merge pull request #19 from broadinstitute/feature.improve-documentation

Improved the documentation wrt to authentication for publishing to

pom.xml

@@ -94,6 +94,24 @@
     </plugins>
   </build>
 
+  <!-- The "distributionManagement" section immediately below arranges for rigerj to be published
+       to GitHub Packages. In order for this to work, however, you need a "~/.m2/settings.xml" file
+       that has your GitHub username and your GitHub token in it. These are required for
+       authentication purposes. There's official documentation for this located here:
+
+       https://docs.github.com/en/packages/guides/configuring-apache-maven-for-use-with-github-packages
+
+       The above documentation page includes an entire sample "settings.xml" file in the
+       documentation. Search for "settings.xml" in the page.
+
+       Just in case this page goes stale, we're including a file in this repo called
+       "sample-settings.xml". Unless you have other settings that you need to merge in, you should
+       be able to use this file sample file as is. Just copy it to "~/.m2/settings.xml" and then
+       replace "USERNAME" with your GitHub username and "TOKEN" with your GitHub token.
+
+       Note that you only need to worry about this if you need to publish new rigerj artifacts.
+  -->
+
   <distributionManagement>
     <repository>
       <id>github</id>

sample-settings.xml

@@ -0,0 +1,38 @@
+<!-- See the notes in rigerj's "pom.xml" that tell you want to do with this file. -->
+
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+  <activeProfiles>
+    <activeProfile>github</activeProfile>
+  </activeProfiles>
+
+  <profiles>
+    <profile>
+      <id>github</id>
+      <repositories>
+        <repository>
+          <id>central</id>
+          <url>https://repo1.maven.org/maven2</url>
+          <releases><enabled>true</enabled></releases>
+          <snapshots><enabled>true</enabled></snapshots>
+        </repository>
+        <repository>
+          <id>github</id>
+          <name>GitHub broadinstitute Apache Maven Packages</name>
+          <url>https://maven.pkg.github.com/broadinstitute/raccoon</url>
+        </repository>
+      </repositories>
+    </profile>
+  </profiles>
+
+  <servers>
+    <server>
+      <id>github</id>
+      <username>USERNAME</username>
+      <password>TOKEN</password>
+    </server>
+  </servers>
+</settings>