You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5f81bed
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,21 +25,23 @@ Follow this deploy process after all changes for the release are merged into mai
25
25
## Release checklist
26
26
27
27
1. Create a branch off `main` and a pull request with the following changes. Copy this checklist in the comment of the pull request.
28
-
- [ ] Update the [CHANGELOG.md](https://github.com/mapbox/mapbox-gl-geocoder/blob/main/CHANGELOG.md) by comparing the last release and what is on `main`. In the changelog, replace the `HEAD` heading with the to-be-released stable version.
28
+
- [ ] Update the [CHANGELOG.md](https://github.com/mapbox/mapbox-gl-geocoder/blob/main/CHANGELOG.md) by comparing the last release and what is on `main`. In the changelog, add the to-be-released stable version heading below `HEAD`.
29
29
- [ ] Update the version number in `package.json` and `package-lock.json`.
30
-
3. Request a PR review and then merge it into `main`.
31
-
4. Tag the release and start the build.
32
-
- [ ] Make sure you've pulled in all changes to `main` locally.
33
-
- [ ] Build the release with `npm run prepublish && npm run docs`
34
-
- [ ] Commit and push with commit message `vX.X.X`
35
-
- [ ] Create the git tag for the release with `git tag -a vX.X.X -m 'vX.X.X'`
36
-
- [ ] Push the tags with `git push --tags`
37
-
- [ ] Run `mbx npm publish`
30
+
- [ ] Run `npm run docs` and commit any changes to `API.md`.
31
+
2. Request a PR review and then merge it into `main`.
32
+
3. Tag the merge commit and publish.
33
+
- [ ] Create the git tag with `git tag -a vX.X.X -m 'vX.X.X'` on the merged commit
34
+
- [ ] Push it with `git push origin vX.X.X`. This starts the `Publish` workflow, which publishes to npm once the `npm-release` environment is approved.
35
+
- [ ] Create a GitHub release for the tag with the changelog entry.
38
36
39
37
40
38
## Post-release checklist
41
39
42
-
Update version number in GL JS examples at [https://github.com/mapbox/mapbox-gl-js-docs](https://github.com/mapbox/mapbox-gl-js-docs):
40
+
Upload to the CDN (make sure you are authenticated for AWS):
43
41
44
-
sed -i '' 's/mapbox-gl-geocoder\/v[^\/]*\//mapbox-gl-geocoder\/vX.X.X\//g' docs/pages/example/*.html
0 commit comments