From e3822e4db6be327253f419a93ecc3ea3b7a86348 Mon Sep 17 00:00:00 2001 From: Katy DeCorah Date: Wed, 13 Mar 2019 14:12:10 -0400 Subject: [PATCH 1/4] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..8b49f324 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ + + + - [ ] briefly describe the changes in this PR + - [ ] write tests for all new functionality + - [ ] update CHANGELOG.md with changes under `master` heading before merging From c7442b44e3f8dabdff82e0000db5370d06b423fe Mon Sep 17 00:00:00 2001 From: Katy DeCorah Date: Wed, 13 Mar 2019 14:12:19 -0400 Subject: [PATCH 2/4] add master heading to changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a170145..8ddf588a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +## master + ## v3.1.4 - Emit a `clear` event when the user backspaces into an empty search bar or selects all existing text and deletes it. From f0a3764f918b42ca9e3c91046d4793fa0979f01b Mon Sep 17 00:00:00 2001 From: Katy DeCorah Date: Wed, 13 Mar 2019 14:12:44 -0400 Subject: [PATCH 3/4] build out deploy steps --- CONTRIBUTING.md | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f4e6d38..5501af73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ npm install & npm start & open http://localhost:9966/ -You'll need a [Mapbox access token](https://www.mapbox.com/help/create-api-access-token/) stored in localstorage. Set it via +You'll need a [Mapbox access token](https://docs.mapbox.com/help/how-mapbox-works/access-tokens/) stored in localstorage. Set it via localStorage.setItem('MapboxAccessToken', ''); @@ -16,13 +16,36 @@ Lastly, run the test command from the console: npm test + ## Deploying -- `npm run prepublish && npm run docs` -- Update the version key in [package.json](https://github.com/mapbox/mapbox-gl-geocoder/blob/master/package.json#L3) -- Outline changes in [CHANGELOG.md](https://github.com/mapbox/mapbox-gl-geocoder/blob/master/CHANGELOG.md) -- Commit and push -- `git tag -a vX.X.X -m 'vX.X.X'` -- `git push --tags` -- `npm publish` -- 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)) +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. + +``` +## Release checklist + +1. Create a branch off `master` and a pull request with the following changes. Copy this checklist in the comment of the pull request. + - [ ] 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. + - [ ] Update the version number in `package.json` and `package.lock.json`. +3. Request a review PR and then merge it into `master`. +4. Tag the release and start the build. + - [ ] Make sure you've pulled in all changes to `master` locally. + - [ ] Build the release with `npm run prepublish && npm run docs` + - [ ] Commit and push with commit message `vX.X.X` + - [ ] Create the git tag for the release with `git tag -a vX.X.X -m 'vX.X.X'` + - [ ] Push the tags with `git push --tags` + - [ ] Run `npm publish` + + +## Post-release checklist + +Update version number in GL JS examples: + +* [ ] [mapbox-gl-geocoder](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder.html) +* [ ] [point-from-geocoder-result](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/point-from-geocoder-result.html) +* [ ] [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) +* [ ] [mapbox-gl-geocoder-limit-region](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-limit-region.html) +* [ ] [mapbox-gl-geocoder-accept-coordinates](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-accept-coordinates.html) +* [ ] [mapbox-gl-geocoder-proximity-bias](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/mapbox-gl-geocoder-proximity-bias.html) +* [ ] [forward-geocode-custom-data](https://github.com/mapbox/mapbox-gl-js/blob/publisher-production/docs/pages/example/forward-geocode-custom-data.html) +``` From 644be0b476af159393d8477ff9f888d24eaf9b6c Mon Sep 17 00:00:00 2001 From: Katy DeCorah Date: Thu, 14 Mar 2019 09:34:36 -0400 Subject: [PATCH 4/4] fix typos --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5501af73..a0ba7592 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,8 +26,8 @@ Follow this deploy process after all changes for the release are merged into mas 1. Create a branch off `master` and a pull request with the following changes. Copy this checklist in the comment of the pull request. - [ ] 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. - - [ ] Update the version number in `package.json` and `package.lock.json`. -3. Request a review PR and then merge it into `master`. + - [ ] Update the version number in `package.json` and `package-lock.json`. +3. Request a PR review and then merge it into `master`. 4. Tag the release and start the build. - [ ] Make sure you've pulled in all changes to `master` locally. - [ ] Build the release with `npm run prepublish && npm run docs`