Simplify electric artifact build process

Author: ggeoffrey

deps.edn

@@ -1,4 +1,18 @@
-{:paths ["src"]
+{:hyperfiddle.build/name com.hyperfiddle/electric
+ :hyperfiddle.build/description "A reactive Clojure dialect for web development that uses a compiler to infer the frontend/backend boundary"
+ :hyperfiddle.build/version "v3-alpha-SNAPSHOT"
+ :hyperfiddle.build/pom-data [[:licenses
+                               [:license
+                                [:name "Hyperfiddle Business Source License"]
+                                [:url "http://hyperfiddle.net"]]]
+                              [:developers
+                               [:developer
+                                [:organization "Hyperfiddle, Inc."]
+                                [:organizationUrl "http://www.hyperfiddle.net"]]]]
+ :hyperfiddle.build/pom-scm {:url "https://github.com/hyperfiddle/electric"
+                             :connection "scm:git:git://github.com/hyperfiddle/electric.git"
+                             :developerConnection "scm:git:ssh://git@github.com/hyperfiddle/electric.git"}
+ :paths ["src"]
  :deps  {
          com.cognitect/transit-clj  {:mvn/version "1.0.333"}
          com.cognitect/transit-cljs {:mvn/version "0.8.280"}
@@ -32,6 +46,6 @@
                                  }}
            :build {:extra-paths ["src-build"]
                    :ns-default  build
-                   :extra-deps  {io.github.clojure/tools.build {:mvn/version "0.9.6"}
-                                 slipset/deps-deploy           {:mvn/version "0.2.2"}}}
-           :release {:override-deps {com.hyperfiddle/hyperfiddle-contrib {:mvn/version "v0-alpha-SNAPSHOT"}}}}}
+                   :extra-deps  {com.hyperfiddle/build {:local/root "../build"}}}
+           :release {:override-deps {com.hyperfiddle/hyperfiddle-contrib {:mvn/version "v0-alpha-SNAPSHOT"}}}}
+ }

src-build/build.clj

@@ -1,62 +1,21 @@
 (ns build
-  "build electric.jar library artifact"
-  (:require [clojure.tools.build.api :as b]
-            [deps-deploy.deps-deploy :as dd]))
+  (:require [clojure.tools.build.api :as tools.build]
+            [hyperfiddle.build :as build]))
+
+;; Expose generic tasks
+(def clean #'build/clean)
+(def install #'build/install)
+(def deploy #'build/deploy)
+
+(defn build [opts] ; custom build task because of AOT
+  (build/clean opts)
+  (let [basis (partial build/create-basis :project "deps.edn", :extra "../electric-secret/deps.edn")
+        {:keys [class-dir src-dirs] :as opts} (build/defaults (basis :aliases [:release]) opts)]
+    (tools.build/write-pom opts)
+    (tools.build/copy-dir {:src-dirs src-dirs, :target-dir class-dir})
+    (tools.build/compile-clj {:basis (basis :aliases [:release :build-deps])
+                              :class-dir class-dir
+                              :ns-compile '[hyperfiddle.electric.impl.entrypoint hyperfiddle.electric.impl.auth hyperfiddle.electric.impl.jwt hyperfiddle.electric.impl.auth0 hyperfiddle.electric.shadow-cljs.hooks3]
+                              :filter-nses '[hyperfiddle.electric.impl.entrypoint hyperfiddle.electric.impl.auth hyperfiddle.electric.impl.jwt hyperfiddle.electric.impl.auth0 hyperfiddle.electric.shadow-cljs.hooks3]})
+    (tools.build/jar opts)))
 
-(def lib 'com.hyperfiddle/electric)
-(def version "v3-alpha-SNAPSHOT" #_(b/git-process {:git-args "describe --long --always --dirty"}))
-(def basis     (b/create-basis {:project "deps.edn", :extra "../electric-secret/deps.edn", :aliases [:release]}))
-(def aot-basis (b/create-basis {:project "deps.edn", :extra "../electric-secret/deps.edn", :aliases [:release :build-deps]}))
-
-(def class-dir "target/classes")
-
-(def defaults {:src-pom "src-build/pom-template.xml" :lib lib :class-dir class-dir})
-
-(defn clean [opts] (b/delete {:path "target"}))
-
-(defn build [{:keys [version] :or {version version} :as opts}]
-  (clean opts)
-  (let [jar-file (format "target/%s-%s.jar" (name lib) version)
-        opts (assoc defaults
-               :version    version
-               :basis      basis
-               :class-dir  class-dir
-               :jar-file   jar-file
-               :scm        {:tag version}
-               :src-dirs   ["src"])]
-    (println "Writing pom.xml")
-    (b/write-pom opts)
-    (println "Copying resources to" class-dir)
-    (b/copy-dir {:src-dirs ["src"], :target-dir class-dir})
-    (b/compile-clj {:basis aot-basis
-                    :class-dir class-dir
-                    :ns-compile '[hyperfiddle.electric.impl.entrypoint hyperfiddle.electric.impl.auth hyperfiddle.electric.impl.jwt hyperfiddle.electric.impl.auth0 hyperfiddle.electric.shadow-cljs.hooks3]
-                    :filter-nses '[hyperfiddle.electric.impl.entrypoint hyperfiddle.electric.impl.auth hyperfiddle.electric.impl.jwt hyperfiddle.electric.impl.auth0 hyperfiddle.electric.shadow-cljs.hooks3]})
-    (println "Building jar" jar-file)
-    (b/jar opts)))
-
-(defn install [{:keys [version] :or {version version}}]
-  (let [jar-file (format "target/%s-%s.jar" (name lib) version)]
-    (b/install {:basis      basis
-                :lib        lib
-                :version    version
-                :jar-file   jar-file
-                :class-dir  class-dir})))
-
-(defn deploy [opts] ; clojars
-  (let [{:keys [lib version class-dir installer jar-file] :as opts} (merge defaults opts)]
-    (assert version ":version is required to deploy")
-    (when (and installer (not= :remote installer))
-      (println ":installer" installer "is deprecated -- use install task for local deployment"))
-    (let [jar-file (or jar-file (format "target/%s-%s.jar" (name (or lib 'application)) version))]
-      (dd/deploy (merge {:installer :remote :artifact (b/resolve-path jar-file)
-                         :pom-file (b/pom-path {:lib lib :class-dir class-dir})}
-                   opts)))))
-
-;; For reference
-#_
-(defn compile-java [_]
-  (b/javac {:src-dirs ["src"]
-            :class-dir "src"
-            :basis basis
-            :javac-opts ["-source" "8" "-target" "8"]}))

src-build/build.md

@@ -1,27 +1,15 @@
 # Build clojars maven artifact — Electric
 
-* versioning scheme is: `v3-alpha-0-g9aae7b1b`
-* `v3`: brand/marketing major version, prefixed by the literal 'v'
-* `alpha`: maturity in {alpha,beta,rc}; see https://clojure.org/releases/devchangelog
-* `0`: number of commits since the tag
-* `g9aae7b1b`: git sha, prefixed by the literal 'g'
-
+Build version is to be set under `deps.edn` > `:hyperfiddle.build/version`.
 
 ```shell
-git tag v3-alpha  # manually set a new tag, or skip to use commit distance from current tag
-clojure -T:build clean
-#clj -A:dev -T user/release -- distribute sources, lib consumer will build
-# HYPERFIDDLE_ELECTRIC_BUILD=`git describe --tags --long --always --dirty` # for definitive, immutable releases
-# HYPERFIDDLE_ELECTRIC_BUILD=`git describe --tags --abbrev=0`-SNAPSHOT # for overwritable maven artifacts
-HYPERFIDDLE_ELECTRIC_BUILD="v3-alpha-SNAPSHOT"
-echo $HYPERFIDDLE_ELECTRIC_BUILD
-clojure -T:build jar :version '"'$HYPERFIDDLE_ELECTRIC_BUILD'"'
-clojure -T:build install :version '"'$HYPERFIDDLE_ELECTRIC_BUILD'"'
+clojure -T:build build
+clojure -T:build install
 # To test in electric-starter-app:
-clj -A:dev -X dev/-main -Sdeps '{:deps {com.hyperfiddle/electric {:mvn/version "'$HYPERFIDDLE_ELECTRIC_BUILD'"}}}'
+clj -A:dev -X dev/-main -Sdeps '{:deps {com.hyperfiddle/electric {:mvn/version "<installed version>"}}}'
 # No way to test remote clojars version without rm in .m2/repositories/com/hyperfiddle
 # Optional: test electric-starter-app with local maven install
-env $(cat .env | xargs) clojure -T:build deploy :version '"'$HYPERFIDDLE_ELECTRIC_BUILD'"'
+env $(cat .env | xargs) clojure -T:build deploy
 ```
 
 - `CLOJARS_USERNAME` is your clojars username.