Skip to content

Commit 95175b4

Browse files
authored
[docs] update deploy process (#198)
* Create PULL_REQUEST_TEMPLATE.md * add master heading to changelog * build out deploy steps * fix typos
1 parent e1ae208 commit 95175b4

File tree

2 files changed

+37
-9
lines changed

2 files changed

+37
-9
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!-- Thanks for the PR! Feel free to add or remove items from the checklist. -->
2+
3+
- [ ] briefly describe the changes in this PR
4+
- [ ] write tests for all new functionality
5+
- [ ] update CHANGELOG.md with changes under `master` heading before merging

CONTRIBUTING.md

+32-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
npm install & npm start & open http://localhost:9966/
44

5-
You'll need a [Mapbox access token](https://www.mapbox.com/help/create-api-access-token/) stored in localstorage. Set it via
5+
You'll need a [Mapbox access token](https://docs.mapbox.com/help/how-mapbox-works/access-tokens/) stored in localstorage. Set it via
66

77
localStorage.setItem('MapboxAccessToken', '<TOKEN HERE>');
88

@@ -16,13 +16,36 @@ Lastly, run the test command from the console:
1616

1717
npm test
1818

19+
1920
## Deploying
2021

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'`
36+
- [ ] Push the tags with `git push --tags`
37+
- [ ] Run `npm publish`
38+
39+
40+
## Post-release checklist
41+
42+
Update version number in GL JS examples:
43+
44+
* [ ] [mapbox-gl-geocoder](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder.html)
45+
* [ ] [point-from-geocoder-result](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/point-from-geocoder-result.html)
46+
* [ ] [mapbox-gl-geocoder-outside-the-map](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-outside-the-map.html)
47+
* [ ] [mapbox-gl-geocoder-limit-region](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-limit-region.html)
48+
* [ ] [mapbox-gl-geocoder-accept-coordinates](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-accept-coordinates.html)
49+
* [ ] [mapbox-gl-geocoder-proximity-bias](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-proximity-bias.html)
50+
* [ ] [forward-geocode-custom-data](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/forward-geocode-custom-data.html)
51+
```

0 commit comments

Comments
 (0)