@tmsoft/webphone 3.0.19 → 3.0.21

package/README.md

@@ -87,6 +87,64 @@ If `onAnswer`, `onHangup` or `onReject` are provided, the component will call th
 `sipCallId` is the SIP dialog identifier. It is not the Asterisk `Uniqueid` or `Linkedid`.
 Consumers may read the emitted streams but must not stop or mutate their tracks; the WebPhone owns their lifecycle.
 
+## Releasing a new version
+
+Publishing is automated: CI reacts to what you push, so a release is a version bump
+plus a push. Never run `npm publish` by hand.
+
+```bash
+# 1. Land the changes on master first — CI publishes what the tag points at.
+git checkout master && git pull
+
+# 2. Bump. Creates the release commit AND the tag in one step.
+npm version patch     # or minor / major
+
+# 3. Push the commit together with its tag.
+git push --follow-tags
+```
+
+Step 2 needs no extra flags because [`.npmrc`](.npmrc) already pins the release
+conventions: `git-tag-version=true` creates the tag, `tag-version-prefix=v` names it
+`vX.Y.Z`, and `message="chore(release): v%s"` writes the commit subject. Bump `minor`
+or `major` for anything past a patch, but keep in mind consumers pinned to `^3.0.x`
+still pick a new minor up automatically.
+
+### What CI does with the tag
+
+| Workflow | Triggered by | Publishes to |
+| --- | --- | --- |
+| [`ci.yml`](.github/workflows/ci.yml) | push to `master` / `develop`, tags `v*`, PRs | — builds and uploads the `dist` artifact |
+| [`publish-npm.yml`](.github/workflows/publish-npm.yml) | successful CI on `master` **or** a `v*` tag | npm as `@tmsoft/webphone` |
+| [`publish-github.yml`](.github/workflows/publish-github.yml) | successful CI on a `v*` tag only | GitHub Packages, rescoped to the repo owner |
+
+Both publish jobs reuse the `dist` artifact CI already built and fall back to
+`yarn install && yarn build:lib` if the download fails.
+
+> Pushing to `master` without a version bump also fires the npm publish job, and it
+> fails on the already-taken version. Harmless, but it is why a red publish run right
+> after a merge is usually not a real problem.
+
+### Consuming the new version
+
+Downstream projects use Yarn 4:
+
+```bash
+yarn up @tmsoft/webphone            # latest — also rewrites the range in package.json
+yarn up @tmsoft/webphone@^3.0.19    # a specific version
+```
+
+Yarn refuses packages younger than its `npmMinimalAgeGate` (24 h by default), which a
+release published minutes ago always trips. Consumers that need to pick a version up
+immediately set `npmMinimalAgeGate: 0` in their `.yarnrc.yml` — as this repo and
+`calloperator-frontend` both do.
+
+Verify the published bundle actually carries the change instead of trusting the
+version number, since the publish jobs reuse a prebuilt artifact:
+
+```bash
+node -p "require('./node_modules/@tmsoft/webphone/package.json').version"
+```
+
 ## License
 
 MIT