Add README and store KAR artifacts

OpenNMS · May 8, 2020 · c3cb7e8 · c3cb7e8
1 parent b1f0f42
commit c3cb7e8
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -32,6 +32,8 @@ jobs:
           key: pris-xls-plugin-{{ checksum "pom.xml" }}
           paths:
             - ~/.m2
+      - store_artifacts:
+          path: kar/target/opennms-pris-plugin.kar
       - persist_to_workspace:
           root: ~/
           paths:

diff --git a/README.md b/README.md
@@ -1,7 +1,10 @@
+
 # PRIS Plugin
 
 PRIS Plugin that can be installed and run on OpenNMS Karaf Container
 
+[![OpenNMS](https://circleci.com/gh/OpenNMS/pris-plugin.svg?style=shield)](https://app.circleci.com/pipelines/github/OpenNMS/pris-plugin)
+
 ## Getting Started
 
 git clone https://github.com/OpenNMS/pris-plugin.git
@@ -73,6 +76,13 @@ sudo cp kar/target/opennms-pris-plugin.kar ~/opt/opennms/deploy/
 
 * [Maven](https://maven.apache.org/) - Dependency Management
 
+## Release
+
+* Version number comes from the `pom.xml` <version> tag
+* Merges to master trigger releases
+* Merges to develop trigger pre-releases
+* All other branches trigger just the build job
+* Branch build artifacts are in CircleCI of the build
 
 ## Acknowledgments