Setup deployments in CI

Author: vemv

.circleci/config.yml

@@ -8,37 +8,55 @@ version: 2.1
 
 # Default settings for executors
 
+env_defaults: &env_defaults
+  LEIN_ROOT: "true"   # we intended to run lein as root
+  # JVM_OPTS:
+  # - limit the maximum heap size to prevent out of memory errors
+  # - print stacktraces to console
+  JVM_OPTS: >
+    -Xmx3200m
+    -Dclojure.main.report=stderr
+
 defaults: &defaults
   working_directory: ~/repo
-  environment:
-    LEIN_ROOT: "true"   # we intended to run lein as root
-    # JVM_OPTS:
-    # - limit the maximum heap size to prevent out of memory errors
-    # - print stacktraces to console
-    JVM_OPTS: >
-      -Xmx3200m
-      -Dclojure.main.report=stderr
 
 # Runners for various OpenJDKs versions.
 # NOTE: JDK 16 can be discarded after a few months, given it's not LTS.
 
 executors:
+  # JDK 8 is preferred for deployments (https://github.com/benedekfazekas/mranderson/issues/57)
+  # Parallelism is disabled, at least for now (https://github.com/benedekfazekas/mranderson/issues/56)
+  openjdk8_deploy:
+    docker:
+      - image: circleci/clojure:openjdk-8-lein-2.9.1-node
+    <<: *defaults
+    environment:
+      LEIN_JVM_OPTS: -Dmranderson.internal.no-parallelism=true
+      <<: *env_defaults
   openjdk8:
     docker:
       - image: circleci/clojure:openjdk-8-lein-2.9.1-node
     <<: *defaults
+    environment:
+      <<: *env_defaults
   openjdk11:
     docker:
       - image: circleci/clojure:openjdk-11-lein-2.9.1-node
     <<: *defaults
+    environment:
+      <<: *env_defaults
   openjdk16:
     docker:
       - image: circleci/clojure:openjdk-16-lein-2.9.5-buster-node
     <<: *defaults
+    environment:
+      <<: *env_defaults
   openjdk17:
     docker:
       - image: circleci/clojure:openjdk-17-lein-2.9.5-buster-node
     <<: *defaults
+    environment:
+      <<: *env_defaults
 
 # Runs a given set of steps, with some standard pre- and post-
 # steps, including restoring of cache, saving of cache.
@@ -111,6 +129,14 @@ jobs:
           cache_version: "1.10"
           steps: << parameters.steps >>
 
+  deploy:
+    executor: openjdk8_deploy
+    steps:
+      - checkout
+      - run:
+         name: Deploy
+         command: |
+           lein with-profile -user,+deploy run -m deploy-release make deploy
 
   test_code:
     description: |
@@ -125,6 +151,7 @@ jobs:
     executor: << parameters.jdk_version >>
     environment:
       VERSION: << parameters.clojure_version >>
+      PROJECT_VERSION: 999.99.9
     steps:
       - checkout
       - with_cache:
@@ -165,71 +192,22 @@ workflows:
   ci-test-matrix:
     jobs:
       - test_code:
-          name: Java 8, Clojure 1.8
-          clojure_version: "1.8"
-          jdk_version: openjdk8
-      - test_code:
-          name: Java 8, Clojure 1.9
-          clojure_version: "1.9"
-          jdk_version: openjdk8
-      - test_code:
-          name: Java 8, Clojure 1.10
-          clojure_version: "1.10"
-          jdk_version: openjdk8
-      - test_code:
-          name: Java 8, Clojure master
-          clojure_version: "master"
-          jdk_version: openjdk8
-      - test_code:
-          name: Java 11, Clojure 1.8
-          clojure_version: "1.8"
-          jdk_version: openjdk11
-      - test_code:
-          name: Java 11, Clojure 1.9
-          clojure_version: "1.9"
-          jdk_version: openjdk11
-      - test_code:
-          name: Java 11, Clojure 1.10
-          clojure_version: "1.10"
-          jdk_version: openjdk11
-      - test_code:
-          name: Java 11, Clojure master
-          clojure_version: "master"
-          jdk_version: openjdk11
-      - test_code:
-          name: Java 16, Clojure 1.8
-          clojure_version: "1.8"
-          jdk_version: openjdk16
-      - test_code:
-          name: Java 16, Clojure 1.9
-          clojure_version: "1.9"
-          jdk_version: openjdk16
-      - test_code:
-          name: Java 16, Clojure 1.10
-          clojure_version: "1.10"
-          jdk_version: openjdk16
-      - test_code:
-          name: Java 16, Clojure master
-          clojure_version: "master"
-          jdk_version: openjdk16
-      - test_code:
-          name: Java 17, Clojure 1.8
-          clojure_version: "1.8"
-          jdk_version: openjdk17
-      - test_code:
-          name: Java 17, Clojure 1.9
-          clojure_version: "1.9"
-          jdk_version: openjdk17
-      - test_code:
-          name: Java 17, Clojure 1.10
-          clojure_version: "1.10"
-          jdk_version: openjdk17
-      - test_code:
-          name: Java 17, Clojure master
-          clojure_version: "master"
-          jdk_version: openjdk17
+          matrix:
+            parameters:
+              clojure_version: ["1.8", "1.9", "1.10", "master"]
+              jdk_version: [openjdk8, openjdk11, openjdk16, openjdk17]
+          filters:
+            branches:
+              only: /.*/
+            tags:
+              only: /^v\d+\.\d+\.\d+(-alpha\d+)?$/
       - util_job:
           name: Code Linting
+          filters:
+            branches:
+              only: /.*/
+            tags:
+              only: /^v\d+\.\d+\.\d+(-alpha\d+)?$/
           steps:
             - run:
                 name: Running cljfmt
@@ -243,3 +221,12 @@ workflows:
                 name: Running Eastwood
                 command: |
                   make eastwood
+      - deploy:
+          requires:
+            - test_code
+            - "Code Linting"
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /^v\d+\.\d+\.\d+(-alpha\d+)?$/

.circleci/deploy/deploy_release.clj

@@ -0,0 +1,39 @@
+(ns deploy-release
+  (:require
+   [clojure.java.io :as io]
+   [clojure.java.shell :refer [sh]]
+   [clojure.string :as str]))
+
+(def release-marker "v")
+
+(defn make-version [tag]
+  (str/replace-first tag release-marker ""))
+
+(defn log-result [m]
+  (println m)
+  m)
+
+(defn -main [& _]
+  (let [tag (System/getenv "CIRCLE_TAG")]
+    (if-not tag
+      (do
+        (println "No CIRCLE_TAG found.")
+        (System/exit 1))
+      (if-not (re-find (re-pattern release-marker) tag)
+        (do
+          (println (format "The `%s` marker was not found in %s." release-marker tag))
+          (System/exit 1))
+        (let [version (make-version tag)
+              version-file (io/file "resources" "cider" "nrepl" "version.edn")]
+          (assert (.exists version-file))
+          (spit version-file (pr-str version))
+          (apply println "Executing" *command-line-args*)
+          (->> [:env (-> {}
+                         (into (System/getenv))
+                         (assoc "PROJECT_VERSION" version)
+                         (dissoc "CLASSPATH"))]
+               (into (vec *command-line-args*))
+               (apply sh)
+               log-result
+               :exit
+               (System/exit)))))))

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test eastwood cljfmt install smoketest release deploy clean detect_timeout
+.PHONY: test eastwood cljfmt install smoketest deploy clean detect_timeout
 
 CLOJURE_VERSION ?= 1.10
 
@@ -21,15 +21,15 @@ tools-deps-test: clean install
 	cd tools-deps-testing; clojure -M:test
 
 eastwood:
-	lein with-profile -user,-dev,+$(CLOJURE_VERSION),+eastwood eastwood
+	lein with-profile -user,-dev,+$(CLOJURE_VERSION),+deploy,+eastwood eastwood
 
 cljfmt:
 	lein with-profile -user,-dev,+$(CLOJURE_VERSION),+cljfmt cljfmt check
 
 kondo:
-	lein with-profile -user,-dev,+clj-kondo run -m clj-kondo.main --lint src
+	lein with-profile -user,-dev,+clj-kondo run -m clj-kondo.main --lint src .circleci/deploy
 
-install: .inline-deps
+install: check-install-env .inline-deps
 	lein with-profile -user,-dev,+$(CLOJURE_VERSION),+plugin.mranderson/config install
 
 smoketest: install
@@ -44,22 +44,27 @@ smoketest: install
 detect_timeout:
 	(bin/ci_detect_timeout &)
 
-# When releasing, the BUMP variable controls which field in the
-# version string will be incremented in the *next* snapshot
-# version. Typically this is either "major", "minor", or "patch".
-
-BUMP ?= patch
-
-release:
-	lein with-profile -user,-dev,+$(CLOJURE_VERSION) release $(BUMP)
-
-# Deploying requires the caller to set environment variables as
-# specified in project.clj to provide a login and password to the
-# artifact repository.
-
-deploy: .inline-deps
+# Deployment is performed via CI by creating a git tag prefixed with "v".
+# Please do not deploy locally as it skips various measures (particularly around mranderson).
+deploy: check-env .inline-deps
 	lein with-profile -user,+$(CLOJURE_VERSION),+plugin.mranderson/config deploy clojars
 
+check-env:
+ifndef CLOJARS_USERNAME
+	$(error CLOJARS_USERNAME is undefined)
+endif
+ifndef CLOJARS_PASSWORD
+	$(error CLOJARS_PASSWORD is undefined)
+endif
+ifndef CIRCLE_TAG
+	$(error CIRCLE_TAG is undefined. Please only perform deployments by publishing git tags. CI will do the rest.)
+endif
+
+check-install-env:
+ifndef PROJECT_VERSION
+	$(error Please set PROJECT_VERSION as an env var beforehand.)
+endif
+
 clean:
 	lein clean
 	cd test/smoketest && lein clean

README.md

@@ -99,15 +99,14 @@ lein with-profile plugin.mranderson/config install
 Release to [clojars](https://clojars.org/):
 
 ```
-lein with-profile plugin.mranderson/config deploy clojars
+git tag -a v0.28.1 -m "0.28.1"
+git push --tags
 ```
 
 Or you can use the `Makefile` as:
 
 ```
-make clean
-make install
-make deploy
+PROJECT_VERSION=0.28.1 make install
 ```
 
 ## Hall of Fame

project.clj

@@ -1,4 +1,5 @@
-(defproject cider/cider-nrepl "0.28.1"
+(defproject cider/cider-nrepl (or (not-empty (System/getenv "PROJECT_VERSION"))
+                                  "0.0.0")
   :description "A collection of nREPL middleware designed to enhance Clojure editors."
   :url "https://github.com/clojure-emacs/cider-nrepl"
   :license {:name "Eclipse Public License"
@@ -143,8 +144,10 @@
                          {:dependencies [[clj-kondo "2021.12.01"]]}]
 
              :eastwood [:test
-                        {:plugins [[jonase/eastwood "1.1.0"]]
+                        {:plugins [[jonase/eastwood "1.2.2"]]
                          :eastwood {:config-files ["eastwood.clj"]
                                     :exclude-namespaces [cider.nrepl.middleware.test-filter-tests]
                                     :ignored-faults {:unused-ret-vals-in-try {cider.nrepl.middleware.profile-test [{:line 25}]}
-                                                     :suspicious-test {cider.nrepl.middleware.profile-test [{:line 25}]}}}}]})
+                                                     :suspicious-test {cider.nrepl.middleware.profile-test [{:line 25}]}}}}]
+
+             :deploy {:source-paths [".circleci/deploy"]}})

resources/cider/nrepl/version.edn

@@ -0,0 +1,3 @@
+;; This file is automatically overwriten from .circleci/deploy/deploy_release.clj,
+;; whenever we perform a deployment.
+"0.0.0"

src/cider/nrepl/version.clj

@@ -4,11 +4,13 @@
 
 (def version-string
   "The current version for cider-nrepl as a string."
-  (-> (or (io/resource "cider/cider-nrepl/project.clj")
-          "project.clj")
+  (-> (io/resource "cider/nrepl/version.edn")
       slurp
-      read-string
-      (nth 2)))
+      read-string))
+
+(assert (seq version-string))
+
+(assert (string? version-string))
 
 (def version
   "Current version of CIDER nREPL as a map.