From 6c4a0af9664f66de84017636540a53a94f5180be Mon Sep 17 00:00:00 2001
From: "Baker, Rory" <rory.baker@fmr.com>
Date: Wed, 26 Apr 2023 06:56:31 -0500
Subject: [PATCH] Revise version schema to comply with Jenkins automated
 releases, and add documentation

---
 VERSIONING.MD | 11 +++++++++++
 pom.xml       |  7 ++++---
 2 files changed, 15 insertions(+), 3 deletions(-)
 create mode 100644 VERSIONING.MD

diff --git a/VERSIONING.MD b/VERSIONING.MD
new file mode 100644
index 0000000..41e0413
--- /dev/null
+++ b/VERSIONING.MD
@@ -0,0 +1,11 @@
+# CDEvents Plugin version
+
+The CDEvents plugin is versioned as follows:
+
+`${revision}-${changelist}`
+
+Where `revision` is incremented to match the spec of the current CDEvents SDK, and `changelist` is automatically
+generated for each release.
+
+In short, increments to `revision` should reflect (potentially breaking) changes to the CDEvents SDK or CDEvents spec,
+while increments to `changelist` should reflect (non-breaking) changes to the CDEvents plugin itself.
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index 029757b..632e3c9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -33,9 +33,10 @@
         <url>https://github.com/${gitHubRepo}</url>
     </scm>
     <properties>
-        <!-- revision: The version of cdevents sdk that this release is based upon -->
-        <revision>v0.1.0-draft6</revision>
+        <!-- revision: Maps Jenkins plugin release to the cdevents SDK version in use. See VERSIONING.MD -->
+        <revision>1</revision>
         <changelist>999999-SNAPSHOT</changelist>
+        <cdevents.version>v0.1.0-draft6</cdevents.version>
         <gitHubRepo>jenkinsci/cdevents-plugin</gitHubRepo>
         <!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
         <!-- Baseline Jenkins version you use to build the plugin. Users must have this version or
@@ -87,7 +88,7 @@
         <dependency>
             <groupId>dev.cdevents.sdk-java</groupId>
             <artifactId>cdevents-sdk-java</artifactId>
-            <version>${revision}</version>
+            <version>${cdevents.version}</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.slf4j</groupId>