This repository uses two separate release flows:
Use this to publish a development (@dev) version of the package for internal testing:
npm run release:devThis will:
- Auto-increment the current prerelease version (e.g.,
1.0.2-dev.3→1.0.2-dev.4) - Publish the current state of the code under the
devdist tag - Does not commit or tag anything in Git
📌 Dev releases are temporary and meant for use in staging/test environments. Only the latest dev version is needed at a time.
Once development is complete and tested, follow these steps:
-
Merge
developmentintomain- Ensure that the latest dev code (including dev version commits) is in the
mainbranch.
- Ensure that the latest dev code (including dev version commits) is in the
-
Run:
npm run release:stableThis will:
- Bump the version (e.g.,
1.0.2) - Generate/update the changelog
- Commit the version bump and changelog
- Tag the release (e.g.,
v1.0.2) - Push to GitHub
- Publish to GitHub Packages under the
latestdist tag
| Command | Use Case | Output Example |
|---|---|---|
release:dev |
Internal testing/dev builds | 1.0.2-dev.4 |
release:stable |
Production/public release | 1.0.2 |
Note: Never run
release:stabledirectly from thedevelopmentbranch. Always mergedevelopmentintomainfirst.