workbench-libs
See GETTING_STARTED.md for information about making changes to workbench-libs.
See CONTRIBUTING.md for information about library versioning.
In this repo:
workbench-azure
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions for talking to Azure APIs.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-azure" % "0.6-9e8bb8d"
workbench-util
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions and classes.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-util" % "0.10-e761452"
workbench-util2
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions and classes. Util2 is added because util needs to support 2.11 for firecloud-orchestration,
but many libraries start to drop 2.11 support. Util2 doesn't support 2.11.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-util2" % "0.8-5781917"
workbench-model
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains generic, externally-facing model classes used across Workbench.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-model" % "0.19-59e30fb"
NOTE: This library uses akka-http's implementation of spray-json and is therefore not compatible with spray, which you shouldn't be using anyway because it is no longer being maintained.
workbench-metrics
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utilities for instrumenting Scala code and reporting to StatsD using metrics-scala and metrics-statsd.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-metrics" % "0.8-e761452"
workbench-google
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions for talking to Google APIs and DAOs for Google PubSub, Google Directory, Google IAM, and Google BigQuery.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-google" % "0.30-59e30fb"
To depend on the MockGoogle* classes, additionally depend on:
"org.broadinstitute.dsde.workbench" %% "workbench-google" % "0.30-3d9bda9" % "test" classifier "tests"
workbench-google2
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions for talking to Google APIs via com.google.cloud client library (more recent) via gRPC.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-google2" % "0.35-5781917"
To start the Google PubSub emulator for unit testing:
docker run --name pubsub-emulator -d -p 8085:8085 -ti google/cloud-sdk:229.0.0 gcloud beta emulators pubsub start --host-port 0.0.0.0:8085
workbench-openTelemetry
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions for publishing custom metrics using openTelemetry (openCensus and openTracing).
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-opentelemetry" % "0.8-5781917"
workbench-error-reporting
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utility functions for publishing custom metrics using openTelemetry (openCensus and openTracing).
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-error-reporting" % "0.8-5781917"
workbench-service-test
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains common classes and utilities for writing tests against Workbench REST web services.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-service-test" % "4.1-8934a35" % "test" classifier "tests"
workbench-notifications
Workbench utility libraries, built for 2.13. You can find the full list of packages at Artifactory.
Contains utilities for publishing email notifications to PubSub for delivery via SendGrid.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-notifications" % "0.6-e761452"
workbench-oauth2
Contains utilities for integrating with Google and B2C oauth.
Latest SBT dependency: "org.broadinstitute.dsde.workbench" %% "workbench-oauth2" % "0.5-59e30fb"