Skip to content

Commit c313153

Browse files
authored
Update release section (#194)
1 parent 1430e62 commit c313153

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

CONTRIBUTING.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,23 @@
22

33
## Releasing
44

5-
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.
5+
> ℹ️ 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.
66
77
> ℹ️ 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.
88
99

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

12-
1. Be sure you have checked out the `master` branch and have pulled latest changes
13-
1. Update the version in `package.json` according to the corresponding minor version of Elastic Maps Service.
14-
1. If necessary, update the `DEFAULT_EMS_VERSION` constant in `ems_client.js`.
12+
1. Be sure you have checked out the `master` or released branch and have pulled latest changes
13+
1. Update the version in `package.json` accordingly.
1514
1. Update the CHANGELOG.md
1615
1. Commit changes with message "bump to x.y.z" where x.y.z is the version in package.json
1716
1. Tag the commit with `git tag vx.y.x`, for example `git tag v7.2.1`
1817
1. Push commits and tags upstream with `git push upstream master && git push upstream --tags` (and optionally to your own fork as well)
1918
1. Update the latest major branch on upstream with `git push upstream <major_branch>`
2019
1. Build the targets with `yarn build`
2120
1. Publish to npm with `npm publish --access public`
22-
21+
1. If necessary, push the new branch upstream and create/archive Snyk targets
2322

2423
## Continuous Integration
2524

0 commit comments

Comments
 (0)