From 5652b14282116ed649a539ce293966aa3b31c151 Mon Sep 17 00:00:00 2001 From: Owen Pearson Date: Fri, 24 Mar 2023 14:06:05 +0000 Subject: [PATCH] doc: add release process --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2497345..074711e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,3 +16,15 @@ JavaScript/TypeScript code is: ## Assembly The project is built using [webpack](https://webpack.js.org/). You can build the project using `npm run build`. This will create a [minified](https://en.wikipedia.org/wiki/Minification_(programming)) JS bundle at `dist/main.js`. + +## Release process + +1. Make sure the tests are passing in CI for the branch you're building +2. Create a new branch for the release, for example `release/1.2.3` +3. Update the [CHANGELOG.md](./CHANGELOG.md) with any customer-affecting changes since the last release and add this to the git index +4. Run `npm version --no-git-tag-version` with the new version and add the changes to the git index +5. Create a PR for the release branch +6. Once the release PR is landed to the `main` branch, checkout the `main` branch locally (remember to pull the remote changes) and run `npm run build` +7. Run `git tag ` with the new version and push the tag to git +8. Run `npm publish .` (should require OTP) - publishes to NPM +10. Visit https://github.com/ably/ably-asset-tracking-js/tags and add release notes to the release (you can just copy the entry you added to the CHANGELOG)