Create KLARRIO.md

KLARRIO.md

@@ -0,0 +1,94 @@
+# KLARRIO build instructions
+## Creating a new release
+1. Bump the version in the pom.xml file. The first part is the upstream version, the second part the Klarrio version of that particular upstream.
+2. `mvn deploy` (see below)
+3. tag & release on github
+
+## Deployment
+To deploy the library to Artifactory, you need to create a Maven settings file:
+
+* go to the [Jfrog Artifactory Repository Browser](https://klarrio.jfrog.io/)
+* Click on 'Set Me Up'
+* Select Maven - Generate Maven Settings
+* Fill in your password, and all settings for the repos
+* Click 'Generate Settings' - 'Download Snippet' (if this is not available, see below)
+* Save the settings.xml file to ~/.m2
+* In this file you need to add 2 properties:
+
+```  
+  <profiles>
+    <profile>
+      <properties>
+        <artifactoryusername>[email protected]</artifactoryusername>
+        <artifactorypassword>APXYZAbcDeftJGWzg7jyaBhJs</artifactorypassword>
+      </properties>
+```
+
+Once this is set up, you can deploy the library using
+`mvn deploy`
+
+### When 'Generate Settings' is greyed out
+Copy the template below, substitute `...` with your username and password, and save it as `~/.m2/settings.xml`.
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.1.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <servers>
+    <server>
+      <username>[email protected]</username>
+      <password>...</password>
+      <id>central</id>
+    </server>
+    <server>
+      <username>[email protected]</username>
+      <password>...</password>
+      <id>snapshots</id>
+    </server>
+  </servers>
+  <profiles>
+    <profile>
+      <properties>
+        <artifactoryusername>[email protected]</artifactoryusername>
+        <artifactorypassword></artifactorypassword>
+      </properties>
+      <repositories>
+        <repository>
+          <snapshots>
+            <enabled>false</enabled>
+          </snapshots>
+          <id>central</id>
+          <name>jvm-libs</name>
+          <url>https://klarrio.jfrog.io/klarrio/jvm-libs</url>
+        </repository>
+        <repository>
+          <snapshots />
+          <id>snapshots</id>
+          <name>jvm-libs</name>
+          <url>https://klarrio.jfrog.io/klarrio/jvm-libs</url>
+        </repository>
+      </repositories>
+      <pluginRepositories>
+        <pluginRepository>
+          <snapshots>
+            <enabled>false</enabled>
+          </snapshots>
+          <id>central</id>
+          <name>jvm-libs</name>
+          <url>https://klarrio.jfrog.io/klarrio/jvm-libs</url>
+        </pluginRepository>
+        <pluginRepository>
+          <snapshots />
+          <id>snapshots</id>
+          <name>jvm-libs</name>
+          <url>https://klarrio.jfrog.io/klarrio/jvm-libs</url>
+        </pluginRepository>
+      </pluginRepositories>
+      <id>artifactory</id>
+    </profile>
+  </profiles>
+  <activeProfiles>
+    <activeProfile>artifactory</activeProfile>
+  </activeProfiles>
+</settings>
+```