Liking cljdoc? Tell your friends :D

Development Instructions


./scripts/lein-modules do clean, install

Running tests

./scripts/ clj
./scripts/ cljs


clojure-lsp format
clojure-lsp clean-ns


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

Making a release

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

# Check that you're using Java 8! Making the release with a newer Java version
# means that it is broken when used with Java 8.
java -version

# 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
  • Remembor to update the changelog!
  • Announce the release at least on #reitit in Clojurians.

Can you improve this documentation? These fine people already did:
Miikka Koskinen & Tommi Reiman
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close