Used when QA is complete and the version is ready for production.
Tag format: v1.28.0 (semver, no suffix)
git pull origin master
git tag v1.28.0
git push origin v1.28.0What CircleCI does (build-and-release workflow):
- Builds, lints, tests, and generates coverage
- Pauses for manual approval (
sdk-release-verification) - Publishes to npm as
latest - Publishes documentation to
gh-pages - Creates a GitHub Release with
miniapp.bundle.jsattached
MiniApp team installs it as:
npm install js-miniapp-sdk
# or pinned
npm install js-miniapp-sdk@1.28.0Used to share a work-in-progress version with a specific team before QA is complete.
Tag format: v1.28.0-rc.1 (any suffix after -)
git pull origin master
git tag v1.28.0-rc.1
git push origin v1.28.0-rc.1What CircleCI does (pre-release workflow):
- Builds, lints, tests, and generates coverage
- Pauses for manual approval (
sdk-prerelease-verification) - Publishes to npm under the
nextdist-tag (does not affectlatest) - Creates a GitHub Pre-release with
miniapp.bundle.jsattached - Documentation is not published
MiniApp team installs it as:
npm install js-miniapp-sdk@next
# or pinned to exact version
npm install js-miniapp-sdk@1.28.0-rc.1Once QA passes, tag the same commit as a stable release:
git tag v1.28.0
git push origin v1.28.0This triggers the build-and-release workflow and publishes as latest on npm.
| Scenario | Tag Example |
|---|---|
| Stable release | v1.28.0 |
| Release candidate | v1.28.0-rc.1 |
| Beta | v1.28.0-beta.1 |
| Hotfix candidate | v1.28.1-rc.1 |
Any tag containing a - triggers the pre-release pipeline.
Any tag matching exact semver (vX.Y.Z) triggers the stable pipeline.