Releasing a new Jayvee version
Version Numbers
In this early stage of the project we do not yet follow semantic versioning since we expect the introduction of breaking changes frequently.
To indicate that, we only release alpha versions where the version
is incremented with every release.
- For the npm packages, we use the version
0.0.<version>
. - For the GitHub releases, we use the git tag
v0.0.<version>-alpha
.
Jayvee Release Procedure
For releasing a new version of Jayvee, you need to complete the following steps:
- Increment the version in the
package.json
file. - Run
npm i
to update thepackage-lock.json
. - Run
npx nx run docs:version-snapshot
to generate a snapshot of the docs for the previous version. - If you are on a feature or dev branch, merge into main.
- Create a GitHub release on the main branch. Attach a changelog.
- The CI/CD will deal with the rest.