@voxel51/voodo 0.0.41 → 0.2.0-dev-prerelease-publishing.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -88,7 +88,27 @@ General rules of thumb:
88
88
 
89
89
  ## Publishing
90
90
 
91
- This library is published to NPM via GitHub Actions workflows.
91
+ Pushing a `v*` tag publishes to NPM via the `release` workflow.
92
+
93
+ Stable release, on `main`:
94
+
95
+ ```shell
96
+ npm version minor && git push --follow-tags
97
+ ```
98
+
99
+ The tag must match `package.json` or the workflow fails.
100
+
101
+ Prerelease, on any branch:
102
+
103
+ ```shell
104
+ git tag v0.2.0-dev-my-feature.0 && git push origin v0.2.0-dev-my-feature.0
105
+ ```
106
+
107
+ Prerelease versions (`vX.Y.Z-<id>.N`) are stamped from the tag — they never
108
+ appear in `package.json` — and publish under NPM dist-tag `<id>`
109
+ (`npm i @voxel51/voodo@dev-my-feature`), so `latest` only moves on stable
110
+ releases. Use `rc` as the id for release candidates from `main` and
111
+ `dev-<branch>` for feature-branch builds.
92
112
 
93
113
  This library is currently in a pre-release state, with versions matching `0.x.y`.
94
114
  Standard semantic versioning will be enforced starting with version `1.0.0`.