Skip to content

Commit 4e2cf7c

Browse files
authored
Release V4.0.0 (#204)
* Update release instructions * Add v4.0.0 notes to changelog * 4.0.0
1 parent 4a54117 commit 4e2cf7c

File tree

4 files changed

+21
-20
lines changed

4 files changed

+21
-20
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## 4.0.0
2+
- [Refactor] options passed to internal Geocoder class
3+
- Made options.geocoder dynamic, accepting only query parameters from the Geocoding API
4+
- Removed placeholder option in favor of placeholderOrigin and placeholderDestination
5+
- Added top level options flyTo, zoom, placeholderOrigin and placeholderDestination
6+
- [Chore] Update packages to resolve vulnerabilities in smokestack
7+
18
## 3.1.3
29
- [bug] Bump package `suggestions` to support autocompletion on quick keypress.[#179](https://github.com/mapbox/mapbox-gl-directions/pull/179)
310

CONTRIBUTING.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,25 @@
1-
### Dependencies
2-
3-
- [node.js](https://nodejs.org/en/) >= 0.12
4-
51
### Developing
62

73
npm install & npm start & open http://localhost:9966/example/
84

95
You'll need a [Mapbox access token](https://www.mapbox.com/help/create-api-access-token/) stored in localstorage. Set it via
106

11-
localStorage.setItem('MapboxAccessToken', '<TOKEN HERE>');
7+
localStorage.setItem('MapboxAccessToken', '<YOUR ACCESS TOKEN>');
128

139
### Testing
1410

1511
Tests require an MapboxAccessToken env variable to be set.
1612

17-
export MapboxAccessToken="YOUR ACCESS TOKEN"
18-
19-
Lastly, run the test command from the console:
20-
21-
npm test
13+
export MapboxAccessToken=<YOUR ACCESS TOKEN> && npm test
2214

23-
### Deploying
15+
### Release process
2416

25-
- `npm test`
26-
- Update `[CHANGELOG.md](https://github.com/mapbox/mapbox-gl-directions/blob/master/CHANGELOG.md)`
27-
- `git commit -am "Update changelog"`
28-
- `npm version {major|minor|patch}`
29-
- `git push --follow-tags`
30-
- `npm publish`
31-
- update version number on [GL JS example page](https://github.com/mapbox/mapbox-gl-js/blob/mb-pages/docs/_posts/examples/3400-01-11-mapbox-gl-directions.html)
17+
1. `git checkout master`
18+
1. `git pull --rebase --autostash` to ensure you have the latest changes.
19+
1. `export MapboxAccessToken=<YOUR ACCESS TOKEN> && npm test`
20+
1. Update [`CHANGELOG.md`](https://github.com/mapbox/mapbox-gl-directions/blob/master/CHANGELOG.md)
21+
1. `npm version {major|minor|patch}`
22+
1. Create a release branch off of master that updates `CHANGELOG.md` and increments `package.json`.
23+
1. `git push --follow-tags`
24+
1. `mbx npm publish`
25+
1. Update version number on [GL JS example page](https://github.com/mapbox/mapbox-gl-js/blob/mb-pages/docs/_posts/examples/3400-01-11-mapbox-gl-directions.html)

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@mapbox/mapbox-gl-directions",
3-
"version": "3.1.3",
3+
"version": "4.0.0",
44
"description": "A mapboxgl plugin for the Mapbox Directions API",
55
"main": "./src/index.js",
66
"browserify": {

0 commit comments

Comments
 (0)