Synfhir Core

A collection of general utility scripts and Moleculer JS mixins.

Versioning and Publishing

As synfhir-core is now a public published package and all changes should have (semantic versioning)[https://semver.org/] applied to ensure we don't break intended behaviour for our consumers.

To make revisions please use the inbuilt npm version major|minor|patch.

To publish just run npm publish and follow the on screen instructions. I have noticed that the MFA phase needs to be completed before hitting enter contrary to the instructions but this could be OS specific.

Tagged Versions

It is possible to tag releases that don't impact the main "@latest" npm repository version. This is very useful for testing changes.

Assume you have a feature branch with changes feature/banana, once complete your changes will create a new version 1.1.1. On this branch you can add a custom tag version, lets assume this tag is beta. To tag this branch correctly you need to run npm version 1.1.1-beta.0. Note that the [TAG].[#] pattern allows you to sub version your changes (e.g. 1.1.1-beta.0, 1.1.1-beta.1).

With the above change made, you can now publish this as a tagged release npm publish --tag beta where the tag values matches your chosen tag (e.g. beta, alpha etc). This does not modify the current latest tip in NPM (e.g. 1.1.0) and so all other consumers will always receive this version when doing npm install.

Now in your consuming service you can run npm install @synanetics/[email protected] and install this package.

NPM provides a convenient way to purge tags to npm dist-tag rm <pkg> <tag> but be sure you aren't removing packages others have built with the same tag. You can always see available tags using npm info @synanetics/synfhir-core.