RELEASE.md

Release Procedure

Check for "Release Blocker" issues or PRs

If there are any open "Release Blocker" issues or PRs, we cannot do a release.

Get the latest master

git checkout master
git fetch
git merge --ff-only origin/master

Merge mb-pages into master

git merge origin/mb-pages

Make sure your environment is in a good state

npm install
npm test
npm run test-suite

Test examples

Start the docs server by running

npm run start-docs

Test at least the following examples before continuing

• Add GeoJSON markers
• Animate a point
• Get features under the mouse pointer
• Fly to a location based on scroll position
• Display markers with popups
• Highlight features under the mouse pointer
• Dispay driving directions
• Set a point after Geocoder result

Choose version number

Choose a new version number, respecting semver.

Update CHANGELOG.md

Update CHANGELOG.md with all changes since the last release. A list of commits is available on the GitHub Releases page through a link that says "X commits to master since this release"

Update version number

Update the version number in package.json, README.md, bench/fps/site.js, _config.yml, and _config.mb-pages.yml.

Commit and tag release

After carefully inspecting the diff, commit and tag the release. There is no going back once you execute this command! A published version tag is forever on our CDN.

VERSION=vX.Y.Z # UPDATE ME
git commit -am $VERSION
git tag $VERSION
git push origin --follow-tags

Create a GitHub release

Create a GitHub release using the tag you just pushed and the text in CHANGELOG.md

Wait for CI server to build successfully

The CI server will automatically publish tagged builds to the Mapbox CDN. Wait for this build to finish successfully before proceeding.

Merge master into mb-pages

Merge master into mb-pages and publish the updated documentation.

git checkout mb-pages
git merge master
git push origin mb-pages
git checkout master

Publish to npm

Publish the release to npm. There is no going back once you execute this command! A published npm package is forever.

npm publish