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
@@ -16,13 +16,36 @@ Lastly, run the test command from the console:
16
16
17
17
npm test
18
18
19
+
19
20
## Deploying
20
21
21
-
-`npm run prepublish && npm run docs`
22
-
- Update the version key in [package.json](https://github.com/mapbox/mapbox-gl-geocoder/blob/master/package.json#L3)
23
-
- Outline changes in [CHANGELOG.md](https://github.com/mapbox/mapbox-gl-geocoder/blob/master/CHANGELOG.md)
24
-
- Commit and push
25
-
-`git tag -a vX.X.X -m 'vX.X.X'`
26
-
-`git push --tags`
27
-
-`npm publish`
28
-
- Update version number in GL JS examples ([one](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder.html), [two](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/point-from-geocoder-result.html), [three](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-outside-the-map.html), [four](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-limit-region.html), [five](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-accept-coordinates.html), [six](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-proximity-bias.html), [seven](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/forward-geocode-custom-data.html))
22
+
Follow this deploy process after all changes for the release are merged into master. You will copy and paste this checklist in the comment of the release pull request.
23
+
24
+
```
25
+
## Release checklist
26
+
27
+
1. Create a branch off `master` 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/master/CHANGELOG.md) by comparing the last release and what is on `master`. In the changelog, replace the `master` heading with the to-be-released stable version.
29
+
- [ ] Update the version number in `package.json` and `package-lock.json`.
30
+
3. Request a PR review and then merge it into `master`.
31
+
4. Tag the release and start the build.
32
+
- [ ] Make sure you've pulled in all changes to `master` 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'`
0 commit comments