Move to release-num versioning scheme

For 1.0 we were using a 1.0.<commit-count> version scheme.
Moving forward we'll use the simpler (at least for me) 1.1.<release-num>
version scheme.

We start <release-num> at 44 to account for the 44 known existing
releases of rewrite-clj. Next release will be 1.1.45.

There is some script code around built-versions that could be simplified.
This was determined by the build in the past, but we know what our
built-version will be prior to our build now.
But I've left it as is for now.

Added a new build dir for versioning code. This code is not entirely
shared by build.clj and babashka, but having everything that talks about
versions in one place makes good sense.

Closes #179

Author: lread

CHANGELOG.adoc

@@ -16,7 +16,9 @@ For a list of breaking changes see link:#v1-breaking[breaking changes].
 
 === Unreleased
 
+* dropped the alpha status
 * now properly escaping inline double quotes for coerced strings https://github.com/clj-commons/rewrite-clj/issues/176[#176] - thanks to @ivarref for raising the issue!
+* changed rewrite-clj library version scheme from commit-count to release-num https://github.com/clj-commons/rewrite-clj/issues/179[#179]
 * docs:
 ** docstring fix, was missing `list-node` from toc, thanks @rfhayashi!
 

README.adoc

@@ -25,15 +25,7 @@ A library that reads and writes Clojure, ClojureScript and https://github.com/ed
 
 == Status
 
-*Warning*: v1 Alpha Release
-
-Our first rewrite-clj v1 alpha release was in March of 2021. +
-Since then we have seen wide and successful adoption of rewrite-clj v1 with no show-stoppers. +
-I would drop the alpha status but have not yet seen the following features get a good shake yet in the wild:
-
-. zippers with `:track-position?` enabled
-. zippers using `:auto-resolve` support
-. paredit API
+Rewrite-clj v1 has been successfully and widely adopted.
 
 See https://github.com/clj-commons/rewrite-clj/projects/1[project page for current priorities].
 
@@ -95,11 +87,11 @@ Have an update? Let us know!
 
 == Versioning
 
-Rewrite-clj versioning scheme is: `major`.`minor`.`patch`-`test-qualifier`
+Rewrite-clj versioning scheme is: `major`.`minor`.`release`-`test-qualifier`
 
 * `major` increments when a non alpha release API has been broken - something, as a rule, we'd like to avoid.
 * `minor` increments to convey significant new features have been added.
-* `patch` indicates bug fixes - it is the total number of commits in the repo.
+* `release` indicates small changes or bug fixes - starting with v1.1, it is the rewrite-clj release count over the life of rewrite-clj.
 * `test-qualifier` is absent for stable releases.
 Can be `alpha`, `beta`, `rc1`, etc.
 

bb.edn

@@ -1,5 +1,5 @@
 {:min-bb-version "0.3.7"
- :paths ["script"]
+ :paths ["script" "build"]
  :deps {org.clojure/data.zip {:mvn/version "1.0.0"}
         io.aviso/pretty {:mvn/version "1.1.1"}
         dev.nubank/docopt {:mvn/version "0.6.1-fix7"}

build.clj

@@ -1,18 +1,13 @@
 (ns build
-  (:require [clojure.edn :as edn]
+  (:require [build-util :as bu]
             [clojure.java.io :as io]
             [clojure.tools.build.api :as b]
             [deps-deploy.deps-deploy :as dd]
             [whitespace-linter]))
 
+
 (def lib 'rewrite-clj/rewrite-clj)
-(def version (let [version-template (-> "version.edn" slurp edn/read-string)
-                   patch (b/git-count-revs nil)]
-               (str (:major version-template) "."
-                    (:minor version-template) "."
-                    patch
-                    (cond->> (:qualifier version-template)
-                      true (str "-")))))
+(def version (bu/version-string)) ;; the expectations is some pre-processing has bumped the version when releasing
 (def class-dir "target/classes")
 (def basis (b/create-basis {:project "deps.edn"}))
 (def jar-file (format "target/%s.jar" (name lib)))

build/build_util.clj

@@ -0,0 +1,25 @@
+(ns build-util
+  "Utilities common to and/or shared between bb and build.clj"
+  (:require [clojure.edn :as edn]
+            [rewrite-clj.zip :as z]))
+
+(defn- version []
+  (edn/read-string (slurp "version.edn")))
+
+(defn bump-version
+  "Bump :release in version.edn file while preserving any formatting and comments"
+  []
+  (spit "version.edn"
+        (-> "version.edn"
+            z/of-file
+            (z/find-value z/next :release)
+            z/right
+            (z/edit inc)
+            z/root-string)))
+
+(defn version-string []
+  (let [{:keys [major minor release qualifier]} (version)]
+    (format "%s.%s.%s%s"
+            major minor release (if qualifier
+                                  (str "-" qualifier)
+                                  ""))))

deps.edn

@@ -125,6 +125,7 @@
            :build {:deps {io.github.clojure/tools.build {:git/tag "v0.8.2" :git/sha "ba1a2bf"}
                           slipset/deps-deploy {:mvn/version "0.2.0"}
                           com.camsaul/whitespace-linter {:mvn/version "2022.01.27.04.43"}}
+                   :extra-paths ["src" "build"]
                    :ns-default build}
 
            ;;

doc/04-maintainer-guide.adoc

@@ -49,7 +49,7 @@ If you so wish, you can also locally run all steps up to, but not including, dep
 ----
 bb ci-release prep
 ----
-Be aware though that you will NOT want to check in changes `prep` makes to `CHANGELOG.adoc` and `01-user-guide.adoc`.
+Be aware though that you will NOT want to check in changes `prep` makes to `version.edn`, `CHANGELOG.adoc` and `doc/01-user-guide.adoc`.
 
 === Invoking
 

script/ci_release.clj

@@ -5,7 +5,8 @@
 ;;
 
 (ns ci-release
-  (:require [clojure.java.io :as io]
+  (:require [build-util :as bu]
+            [clojure.java.io :as io]
             [clojure.string :as string]
             [helper.fs :as fs]
             [helper.main :as main]
@@ -128,7 +129,7 @@
     (status/line :head (str  "Committing and pushing changes made for " tag-version))
     (assert-on-ci "commit changes")
     (status/line :detail "Adding changes")
-    (shell/command "git add doc/01-user-guide.adoc CHANGELOG.adoc")
+    (shell/command "git add doc/01-user-guide.adoc CHANGELOG.adoc version.edn")
     (status/line :detail "Committing")
     (shell/command "git commit -m" (str  "Release job: updates for version " tag-version))
     (status/line :detail "Version tagging")
@@ -177,6 +178,7 @@ Options
                 last-version (last-release-tag)]
             (status/line :detail (str "Last version released: " (or last-version "<none>")))
             (io/make-parents "target")
+            (bu/bump-version)
             (create-jar!)
             (let [version (built-version)]
               (status/line :detail (str "Built version: " version))

version.edn

@@ -1,5 +1,6 @@
-;; :patch is determined by release workflow
-;; omit :qualifier for official releases
+;; describes last release and is also a template for the next release
+;; :release is incremented by release workflow
+;; omit :qualifier (ex. :qualifier "alpha") for official releases
 {:major 1
- :minor 0
- :qualifier "alpha"}
+ :minor 1
+ :release 44}