ids

IDs

This sub-project provides a shared library used within datomic transactions and peer-queries.

Latest released version here:

All commands below assume the ids directory as the starting-point working directory.

Build

make clean
make target/wbids.jar

Test

Ensure to run all tests and check they pass before deploying a new release, submitting new pull requests and preferable before committing to the IDs library code.

cd ../
make run-tests
cd -

Release & deployment

The IDs library deployment process consists of three main steps:

1. Build and deploy the library to clojars
2. Update the appropriate Datomic transactors to use this new library
3. Update the main name-service to use the new version of the wormbase/ids dependency and release and deploy a new version of the application (if needed).

Build and deploy to clojars

1. Prepare pom.xml file defining the release version and dependencies

# Generate/update the pom.xml file (not version-controlled)
rm -f pom.xml
clj -Spom

#Check the current clojars version
curl -s -H 'accept: application/json' https://clojars.org/api/artifacts/wormbase/ids | jq .latest_version

# Update the pom.xml to
#   * have a new unique version as <version> tag value (bump x, y or z release nr from current version)
#   * have "wormbase" (unquoted) as <groupId> tag value
#   * have "ids" (unquoted) as <artifactId> tag value
#   * Review the dependencies and compare them to deps.edn
#     (to ensure no extra dependencies slipped in through your ~/.clojure/deps.edn file)
$EDITOR pom.xml

2. Build the library jar as instructed above.

3. Deploy the library jar to clojars.
   This will require the file ~/.m2/settings.xml to be defined as described here (settings.xml part). Clojars username can be obtained by registering at clojars.org and a deploy-token can be generated after that by visiting this page. Ensure you have been added to the wormbase group to allow uploading a new version (ask a colleague).

# Release to clojars
make release

Update Datomic transactors

To update the datomic transactors so they would use a new release of the IDs library, follow the instructions in the wormbase-architecture/transactor README and update the appropriate CF parameter to match the new IDs package release number.

Update the main name-service application dependency

Update the main name-service to use the new version of the wormbase/ids dependency by:

1. Updating it's deps.edn file to point to the latest wormbase/ids release.
2. Release and deploy a new version of the main application (if needed), as describe in the main application's README.