Development Instructions

Building

./scripts/lein-modules do clean, install

Running tests

./scripts/test.sh clj
./scripts/test.sh cljs

Formatting

clojure-lsp format
clojure-lsp clean-ns

Documentation

The documentation lives under doc and it is hosted on cljdoc. See their documentation for library authors

Updating deps

lein ancient upgrade
Mention non-dev non-test dep upgrades in CHANGELOG.md
npm update --save
Make a PR, run CI

Making a release

We use Break Versioning. Remember our promise: patch-level bumps never include breaking changes!

# new version
./scripts/set-version "1.0.0"

# create a release commit and a tag
git add -u
git commit -m "Release 1.0.0"
git tag 1.0.0

# works
./scripts/lein-modules install
lein test

# deploy to clojars
CLOJARS_USERNAME=*** CLOJARS_PASSWORD=*** ./scripts/lein-modules do clean, deploy clojars

# push the commit and the tag
git push
git push --tags

Remember to update the changelog!
Announce the release at least on #reitit in Clojurians.

1.3 KiB Raw Blame History