You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12
Original file line number
Diff line number
Diff line change
@@ -16,3 +16,15 @@ JavaScript/TypeScript code is:
16
16
## Assembly
17
17
18
18
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`.
19
+
20
+
## Release process
21
+
22
+
1. Make sure the tests are passing in CI for the branch you're building
23
+
2. Create a new branch for the release, for example `release/1.2.3`
24
+
3. Update the [CHANGELOG.md](./CHANGELOG.md) with any customer-affecting changes since the last release and add this to the git index
25
+
4. Run `npm version <VERSION_NUMBER> --no-git-tag-version` with the new version and add the changes to the git index
26
+
5. Create a PR for the release branch
27
+
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`
28
+
7. Run `git tag <VERSION_NUMBER>` with the new version and push the tag to git
29
+
8. Run `npm publish .` (should require OTP) - publishes to NPM
30
+
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)
0 commit comments