Setup deployments on CI (#360)

* Setup deployments on CI

* Upgrade Orchard, nrepl, Eastwood

* Adapt `make install` task

* Discard `release` Make task

Author: vemv

.circleci/config.yml

@@ -21,20 +21,34 @@ executors:
       LEIN_ROOT: "true"   # we intended to run lein as root
       JVM_OPTS: -Xmx3200m # limit the maximum heap size to prevent out of memory errors
     <<: *defaults
+
+  # 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
+    environment:
+      LEIN_ROOT: "true"   # we intended to run lein as root
+      LEIN_JVM_OPTS: -Dmranderson.internal.no-parallelism=true
+      JVM_OPTS: -Xmx3200m # limit the maximum heap size to prevent out of memory errors
+    <<: *defaults
+
   openjdk11:
     docker:
       - image: circleci/clojure:openjdk-11-lein-2.9.3-buster-node
     environment:
       LEIN_ROOT: "true"   # we intended to run lein as root
       JVM_OPTS: -Xmx3200m --illegal-access=deny # forbid reflective access (this flag doesn't exist for JDK8 or JDK17+)
     <<: *defaults
+
   openjdk16:
     docker:
       - image: circleci/clojure:openjdk-16-lein-2.9.5-buster-node
     environment:
       LEIN_ROOT: "true"   # we intended to run lein as root
       JVM_OPTS: -Xmx3200m --illegal-access=deny # forbid reflective access (this flag doesn't exist for JDK8 or JDK17+)
     <<: *defaults
+
   openjdk17:
     docker:
       - image: circleci/clojure:openjdk-17-lein-2.9.5-buster-node
@@ -112,6 +126,24 @@ jobs:
           cache_version: "1.10"
           steps: << parameters.steps >>
 
+  deploy:
+    executor: openjdk8_deploy
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-dependencies-{{ checksum "project.clj" }}
+            # fallback to using the latest cache if no exact match is found
+            - v2-dependencies-
+      - run: lein with-profile -user,+test deps
+      - save_cache:
+          paths:
+            - ~/.m2
+          key: v2-dependencies-{{ checksum "project.clj" }}
+      - run:
+         name: Deploy
+         command: |
+           lein with-profile -user,+deploy run -m deploy-relase make deploy
 
   test_code:
     description: |
@@ -165,8 +197,18 @@ workflows:
             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
@@ -180,3 +222,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,32 @@
+(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
+      (System/exit 1)
+      (if-not (re-find (re-pattern release-marker) tag)
+        (System/exit 1)
+        (let [version (make-version tag)]
+          (spit (io/file "resources" "refactor_nrepl" "version.edn")
+                (pr-str version))
+          (apply println "Executing" *command-line-args*)
+          (->> [:env (assoc (into {} (System/getenv))
+                            "PROJECT_VERSION" (make-version tag))]
+               (into (vec *command-line-args*))
+               (apply sh)
+               log-result
+               :exit
+               (System/exit)))))))

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.2.1 (2022-01-21)
+
+* Upgrade Orchard.
+
 ## 3.2.0 (2022-01-09)
 
 ### Changes

Makefile

@@ -1,4 +1,4 @@
-.PHONY: inline-deps test release deploy clean
+.PHONY: inline-deps test deploy clean
 
 VERSION ?= 1.10
 
@@ -30,30 +30,18 @@ eastwood:
 kondo:
 	lein with-profile -dev,+$(VERSION),+clj-kondo run -m clj-kondo.main --lint src test
 
-# 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,+$(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.
-
-# GIT_TAG=v3.2.0 CLOJARS_USERNAME=$USER CLOJARS_PASSWORD=$(pbpaste) make deploy
+# 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,+$(VERSION),+plugin.mranderson/config deploy clojars
-	git tag -a "$$GIT_TAG" -m "$$GIT_TAG"
-	git push
-	git push --tags
 
 jar: .inline-deps
 	lein with-profile -user,+$(VERSION),+plugin.mranderson/config jar
 
-install: .inline-deps
+# Usage: PROJECT_VERSION=3.2.1 make install
+# PROJECT_VERSION is needed because it's not computed dynamically
+install: check-install-env .inline-deps
 	lein with-profile -user,+$(VERSION),+plugin.mranderson/config install
 
 check-env:
@@ -63,6 +51,11 @@ endif
 ifndef CLOJARS_PASSWORD
 	$(error CLOJARS_PASSWORD is undefined)
 endif
-ifndef GIT_TAG
-	$(error GIT_TAG is undefined)
+ifndef CIRCLE_TAG
+	$(error CIRCLE_TAG is undefined)
+endif
+
+check-install-env:
+ifndef PROJECT_VERSION
+	$(error Please set PROJECT_VERSION as an env var beforehand.)
 endif

README.md

@@ -25,7 +25,7 @@ Be aware that this isn't the case if you connect to an already running REPL proc
 Add the following, either in your project's `project.clj`,  or in the `:user` profile found at `~/.lein/profiles.clj`:
 
 ```clojure
-:plugins [[refactor-nrepl "3.2.0"]
+:plugins [[refactor-nrepl "3.2.1"]
           [cider/cider-nrepl "0.25.9"]]
 ```
 
@@ -37,7 +37,7 @@ Add the following in `~/.boot/profile.boot`:
 (require 'boot.repl)
 
 (swap! boot.repl/*default-dependencies* conj
-       '[refactor-nrepl "3.2.0"]
+       '[refactor-nrepl "3.2.1"]
        '[cider/cider-nrepl "0.25.9"])
 
 (swap! boot.repl/*default-middleware* conj
@@ -370,21 +370,14 @@ If you want to use `mranderson` while developing locally with the REPL, the sour
 
 When you want to release locally to the following:
 
-    lein with-profile plugin.mranderson/config install
+    PROJECT_VERSION=3.2.1 make install
 
 And here's how to deploy to Clojars:
 
-    lein with-profile plugin.mranderson/config deploy clojars
-
-Alternatively you can leverage the bundled `Makefile`:
-
-    make install
-    make deploy
-
-You might also want to do a `make test` prior to deploying anything to Clojars.
-
-**Note:** You'll need to run `make clean test` if you changed any of the project's dependencies,
-as those will need to be inlined first.
+```bash
+git tag -a v3.2.1 -m "3.2.1"
+git push --tags
+```
 
 ## Changelog
 

project.clj

@@ -1,16 +1,19 @@
-(defproject refactor-nrepl "3.2.0"
+;; PROJECT_VERSION is set by .circleci/deploy/deploy_release.clj,
+;; whenever we perform a deployment.
+(defproject refactor-nrepl (or (not-empty (System/getenv "PROJECT_VERSION"))
+                               "0.0.0")
   :description "nREPL middleware to support editor-agnostic refactoring"
   :url "https://github.com/clojure-emacs/refactor-nrepl"
   :license {:name "Eclipse Public License"
             :url "https://www.eclipse.org/legal/epl-v10.html"}
-  :dependencies [[nrepl "0.9.0-beta3"]
+  :dependencies [[nrepl "0.9.0"]
                  ^:inline-dep [compliment "0.3.12"]
                  ^:inline-dep [http-kit "2.5.3"]
                  ^:inline-dep [org.clojure/data.json "2.3.1"]
                  ^:inline-dep [org.clojure/tools.analyzer.jvm "1.2.2"]
                  ^:inline-dep [org.clojure/tools.namespace "1.1.0" :exclusions [org.clojure/tools.reader]]
                  ^:inline-dep [org.clojure/tools.reader "1.3.6"]
-                 ^:inline-dep [cider/orchard "0.8.0"]
+                 ^:inline-dep [cider/orchard "0.9.1"]
                  ^:inline-dep [cljfmt "0.8.0" :exclusions [rewrite-clj rewrite-cljs]]
                  ^:inline-dep [clj-commons/fs "1.6.310"]
                  ^:inline-dep [rewrite-clj "1.0.699-alpha"]
@@ -25,7 +28,7 @@
                                     :username :env/clojars_username
                                     :password :env/clojars_password
                                     :sign-releases false}]]
-  :plugins [[thomasa/mranderson "0.5.3"]]
+  :plugins [[thomasa/mranderson "0.5.4-SNAPSHOT"]]
   :mranderson {:project-prefix  "refactor-nrepl.inlined-deps"
                :expositions     [[org.clojure/tools.analyzer.jvm org.clojure/tools.analyzer]]
                :unresolved-tree false}
@@ -66,15 +69,17 @@
                                           with-debug-bindings [[:inner 0]]
                                           merge-meta [[:inner 0]]
                                           try-if-let [[:block 1]]}}}]
-             :eastwood {:plugins         [[jonase/eastwood "1.1.0"]]
+             :eastwood {:plugins         [[jonase/eastwood "1.1.1"]]
                         :eastwood {;; :implicit-dependencies would fail spuriously when the CI matrix runs for Clojure < 1.10,
                                    ;; because :implicit-dependencies can only work for a certain corner case starting from 1.10.
                                    :exclude-linters [:implicit-dependencies]
                                    :exclude-namespaces [refactor-nrepl.plugin]
                                    :add-linters [:performance :boxed-math]
                                    :config-files ["eastwood.clj"]}}
              :clj-kondo [:test
-                         {:dependencies [[clj-kondo "2021.12.19"]]}]}
+                         {:dependencies [[clj-kondo "2021.12.19"]]}]
+
+             :deploy {:source-paths [".circleci/deploy"]}}
 
   :jvm-opts ~(cond-> []
                (System/getenv "CI")

resources/refactor_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/refactor_nrepl/core.clj

@@ -17,11 +17,10 @@
 (require '[me.raynes.fs :as fs])
 
 (defn version []
-  (let [v (-> (or (io/resource "refactor-nrepl/refactor-nrepl/project.clj")
-                  "project.clj")
+  (let [v (-> "refactor_nrepl/version.edn"
+              io/resource
               slurp
-              read-string
-              (nth 2))]
+              read-string)]
     (assert (string? v)
             (str "Something went wrong, version is not a string: "
                  v))

test/refactor_nrepl/ns/class_search_test.clj

@@ -30,7 +30,7 @@
               "jdk."
               ;; Odd stuff brought in by the `fs` dependency:
               "Implementing class"
-              "class org.apache.commons.compress.harmony.pack200.Segment can not implement org.objectweb.asm.ClassVisitor"])
+              "org.apache.commons.compress.harmony.pack200.Segment can not implement"])
        (do
          (.printStackTrace e)
          false))