Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 1.2 KB

Contributing to @elastic/ems-client

Releasing

Releases for @elastic/ems-client must match the corresponding minor version of Elastic Maps Service (EMS). Patch releases (e.g. v7.2.1) can be created for bug fixes.

ℹ️ Elastic Maps Service may not have minor releases. For example, there are no v7.1 or v7.3 releases for EMS. So @elastic/ems-client may also skip minor releases.

If you have access to make releases, the process is as follows:

  1. Be sure you have checked out the master branch and have pulled latest changes
  2. Update the version in package.json according to the corresponding minor version of Elastic Maps Service.
  3. If necessary, update the DEFAULT_EMS_VERSION constant in ems_client.js.
  4. Update the CHANGELOG.md
  5. Commit changes with message "bump to x.y.z" where x.y.z is the version in package.json
  6. Tag the commit with git tag vx.y.x, for example git tag v7.2.1
  7. Push commits and tags upstream with git push upstream master && git push upstream --tags (and optionally to your own fork as well)
  8. Update the latest major branch on upstream with git push upstream <major_branch>
  9. Build the targets with yarn build
  10. Publish to npm with npm publish --access public