@mapbox/assembly 1.16.1-dev.2 → 1.16.1-dev.3
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 +12 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -157,16 +157,15 @@ For other scripts, look in `package.json`.
|
|
|
157
157
|
|
|
158
158
|
### Releasing
|
|
159
159
|
|
|
160
|
-
Development
|
|
161
|
-
|
|
162
|
-
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
-
|
|
168
|
-
-
|
|
169
|
-
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
- Deploy the changes (`deploy.yml` runs automatically on push to `staging`/`production`). Talk to **@mapbox/frontend-platform** if you need help.
|
|
160
|
+
Development and releases both happen on `main` (a single branch — no more `publisher-staging`/`publisher-production` split). Here's how you cut a release:
|
|
161
|
+
|
|
162
|
+
- Document changes in the [`CHANGELOG`](https://github.com/mapbox/assembly/blob/main/CHANGELOG.md).
|
|
163
|
+
- Increment the version key in `package.json` and `package-lock.json`.
|
|
164
|
+
- Make sure all this is committed, typically with a commit message like `Prepare 0.8.0`, and merged to `main`.
|
|
165
|
+
- Create a tag matching the version, prefixed with `v`. For example: `git tag v0.8.0`.
|
|
166
|
+
- Push the tag: `git push origin v0.8.0`.
|
|
167
|
+
- This triggers two GitHub Actions workflows off the tag push:
|
|
168
|
+
- `NPM release`, which publishes to npm via [Trusted Publishing](https://docs.npmjs.com/trusted-publishers/) (OIDC) — no npm token needed.
|
|
169
|
+
- `Deploy`, which uploads the versioned CDN build to `mapbox-assembly` (`scripts/deploy.js`) and syncs the docs site (`_site`) to `labs.mapbox.com`.
|
|
170
|
+
- Tags containing `.dev` or `-dev` (e.g. `v0.8.0.dev.0`, `v0.8.0-dev.0`) are dev releases: they publish under the npm `dev` dist-tag instead of `latest`, deploy the docs site to `labs.mapbox.com-staging` instead of production, and can be cut from any branch (not just `main`) for testing.
|
|
171
|
+
- Non-dev tags must point to a commit on `main`, or both workflows fail fast.
|