service-utils aims at swapping common functionality for most/all backend services in order to reduce code duplication.
Future use-cases should include logging, inter-service communication, metrics etc.
Development of service-utils package will take place in your local machine, not within the docker context. Therefore, some adoptions and preparations are necessary. Follow these steps for initial setup:
- Navigate to
packages/service-utils - Run
yarn link - Navigate to
services/backend - Run
yarn link @lucaapp/service-utils
This will connect your local sources for @lucaapp/service-utils.
When making changes within the package, make sure to run the build target within packages/service-utils/package.json to have the changes available to backend web.
After this preparations run package-development from services/backend/package.json.
The following environment should be at least in place when running the target to make sure your local backend setup uses the proper endpoints:
export DB_HOSTNAME=localhost
export KAFKA_BROKER=localhost:9094
export REDIS_HOSTNAME=localhostIt will utilize the linked package and run backend locally.
Make sure your docker stack has at least database, kafka and redis, but not backend up and running.
You should now be able to develop changes for @lucaapp/service-utils.
Packaging of @lucaapp/service-utils will be automatically published, when run in dev.
See ./gitlab-ci/publish[.template].yml for reference.
Make sure to follow semantic-release conventions when writing commit messages.
Depending on the used semantic-release indicators a new version of @lucaapp/service-utils will be made available and tagged within the luca-web repository.