Releases
A release is created when there is enough new features or bug fixes to justify a new version. A release is created from the main branch and is tagged with the version number following Semantic Versioning.
Create a release
In order to be sure that every packages use the same version, we create script to automate the process. This script is written using NodeJS and can be found in the scripts folder.
Prerequisites
- NodeJS (latest LTS version)
Steps
- Install dependencies
pnpm installnpm i -g pnpm- Run the script
pnpm run update-versions <version>- Create a PR with the changes (an action will be triggered to check that each package has the same version)
- Merge the PR
- Create a new release on GitHub
And that's it! The new version is now available on all packages.
Edge Release Channel
API is landing commits, improvements and bug fixes every day. You can opt-in to the Edge release channel to get the latest features and fixes as soon as they are ready.
After each commit is merged into the main branch, packages are built and deployed to registries.
The build and publishing method and quality of edge releases are the same as stable ones. The only difference is that you should often check the GitHub repository for updates. There is a slight change of regressions not being caught during the review process and by the automated tests. Therefore, we internally use this channel to double-check everything before each release.
C# packages
C# packages are available on NuGet.
C# generate also packages on each PR commit. This is useful to test or implement features in parallel to validate that proto are correct. You can find the latest version on NuGet.
Python
Python package is available on PyPi.
Angular
Angular package is available on NPM.
Web
Web package is available on NPM.