diff --git a/KLARRIO.md b/KLARRIO.md new file mode 100644 index 0000000..d3eb928 --- /dev/null +++ b/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: + +``` + + + + you@klarrio.com + APXYZAbcDeftJGWzg7jyaBhJs + +``` + +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`. + +``` + + + + + ...@klarrio.com + ... + central + + + ...@klarrio.com + ... + snapshots + + + + + + ...@klarrio.com + + + + + + false + + central + jvm-libs + https://klarrio.jfrog.io/klarrio/jvm-libs + + + + snapshots + jvm-libs + https://klarrio.jfrog.io/klarrio/jvm-libs + + + + + + false + + central + jvm-libs + https://klarrio.jfrog.io/klarrio/jvm-libs + + + + snapshots + jvm-libs + https://klarrio.jfrog.io/klarrio/jvm-libs + + + artifactory + + + + artifactory + + +```