Development Guide

We use yarn workspaces, please use yarn.

Start all the services in dev mode

yarn dev

Make sure that associated services are available on the localhost - e.g. mongo, minio, redis

Prevent CI

Add [skip ci] to commit message to skip running CI.

Releasing a new version

We use semver standard.

Every commit to master triggers CI via GH Actions, which builds new docker images, assign tags and pusher the new images to DockerHub.

After pushing a new tagged please go ahead and create a new Github release with a summary and attributions.

Releasing latest tag

Pushing to master automatically created new docker images with latest tags

Releasing tagged version e.g. v1.0.0-beta.4

  1. Run yarn release to create a new release.

  2. Push to master. Push to master, together with tags git push origin master --tags. Pushing to master will trigger CI that will actually update dockerhub.

Pushing a properly formatted (semver) git tag starts release of dockerhub images tagged accordingly. E.g. v0.5.2 will release dockerhub tags v0, v0.5, v0.5.2.

The script does the following behind the scenes:

  • Update all package.json files (we release all together and do not increase / release individual packages version)

  • Commit with message, e.g. v0.5.2

  • Add git tag, e.g. git tag v0.5.2