@elastic/ems-client/CONTRIBUTING.md

JavaScript client library for the Elastic Maps Service

# Contributing to @elastic/ems-client

## Releasing

> ℹ️ Before 8.5.0, 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. **8.5.0** is the first release decoupled of the rest of the Elastic Stack given the stability of the EMS services, and will only do new releases when necessary.

> ℹ️ 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
1. Update the version in `package.json` accordingly.
1. Update the CHANGELOG.md
1. Commit changes with message "bump to x.y.z" where x.y.z is the version in package.json
1. Tag the commit with `git tag vx.y.z`, for example `git tag v7.2.1`
1. Push commits and tags upstream with `git push upstream master && git push upstream --tags` (and optionally to your own fork as well)
1. The [publish workflow](.github/workflows/publish.yml) will automatically build and publish to npm via [npm Trusted Publishers](https://docs.npmjs.com/trusted-publishers) when the tag is pushed
1. Monitor the publish run in the repository's [Actions tab](https://github.com/elastic/ems-client/actions/workflows/publish.yml)

## Continuous Integration

This repository is tracked by Elastic [Buildkite infrastructure](https://buildkite.com/elastic) to ensure the tests suite passes and a build is successfully generated. The pipeline is located at [`.buildkite/pipeline.yml`](.buildkite/pipeline.yml), and defines the execution of the `test` and `build` scripts from `package.json`.

Builds are **triggered** on the following conditions:

* Any push to `master`
* Any Pull Request coming from a branch in the `elastic/ems-client` repository
* It will run automatically on `master` on a weekly basis
* Comments from Elastic team members on a Pull Request like: `buildkite test this`

Builds will be **skipped** on:

* Pull Requests from forks from users that don't have write/admin permissions on the upstream repository (`elastic/ems-client`) or are not part of the Elastic GitHub organization.
* Pull Requests with the `skip-ci` label
* Pull Requests with all files modified matching any of the regular expressions in `.buildkite/pull-requests.json => skip_ci_on_only_changed`