How to build and test
Use an authorised xitstash checkout with Java 21 or later, Clojure CLI and Babashka.
Install cljfmt and clj-kondo for formatting and lint.
The library runs on Java 17, but the test-only Closure Compiler requires Java 21.
Run the normal checks
bb ci
This compiles Java with warnings treated as errors, runs the unit tests and checks Clojure formatting and lint.
Use bb qa to apply formatting before lint and tests.
To run one test namespace:
bb test --focus ol.xitstash.multiformats-interop-test
Run adapter tests
Supply local xitdb-clj and Yggdrasil checkouts. The tested revisions are:
| Project | Revision |
|---|---|
xitdb-clj |
|
Yggdrasil |
|
xitdb-java |
Maven version |
The Yggdrasil revision contains an unpublished xitdb adapter.
A released Yggdrasil dependency does not supply it.
The checkout must provide yggdrasil.adapters.xitdb with create, read!, transact! and compact!.
Replace both paths and run:
bb javac
clojure -Sdeps '{:deps {codeboost/xitdb-clj {:local/root "/path/to/xitdb-clj"}
org.replikativ/yggdrasil {:local/root "/path/to/yggdrasil"}}}' \
-M:kaocha:integration --config-file integration/tests.edn
This runs unit and integration suites.
Append :integration to select only the integration suite.
The adapter tests cover mixed application and binary writes, rollback, branch isolation, historical reads and compaction/reopen. They do not cover ClojureScript, generic catalog merging or selective erasure across adapter history. Default CI and Nix package builds do not run these optional tests.
Run measurements
bb bench
For a fresh-JVM memory check on Linux:
bb javac
clojure -J-Xmx128m -M:bench --memory small
clojure -J-Xmx128m -M:bench --memory large
See Performance measurements for conditions and interpretation.
Generate documentation
bb gen-docs
This copies README.adoc into the component index, generates the public API reference from ol.xitstash and writes doc/manifest.edn.
Edit the README or source docstrings rather than their generated pages.
Edit other reader pages under doc/modules/ROOT/pages/.
Keep AGENTS.md and docs/agents/ in Markdown.