---

This repository holds a Gradle multi-project containing shared source code files for ExplorViz backend services. Each subproject contains files that serve a single purpose, e.g., user model, security matters, or injection of config variables.

You can easily add a subproject to your service by using Jitpack. Follow Jitpack's How to section and finally add a subproject to your dependencies as shown below, where SUBPROJECTNAME has to be replaced with the name of the desired subproject.

dependencies {
  ...
  
  // use release 1.3.1
  implementation 'com.github.explorviz.explorviz-backend-shared:SUBPROJECTNAME:v1.3.1'

  // use latest commit of master branch
  // implementation 'com.github.explorviz.explorviz-backend-shared:SUBPROJECTNAME:master-SNAPSHOT'
}

Local Development

If you want to locally develop against this repository, therefore do not wait for Jitpack all the time, see the gradle.properties file of the explorviz-backend root project.

Tag latest state

To tag the latest state of the master branch execute the following procedure:

1. Checkout master and merge necessary branches (e.g. of pull requests)
2. git tag -a v1.X.Y.Z -m "shared source files for ExplorViz version 1.X.Y.Z" where X, Y, Z are the values for the last tag incremented by one. Most of the time, you only need to increment the patch version Y and Z.
3. git push origin master --tags
4. If required: Update the tag version in related projects, e.g. explorviz-backend.