Skip to content

Commit

Permalink
Merge pull request #133 from ably/add-release-process
Browse files Browse the repository at this point in the history
doc: add release process
  • Loading branch information
owenpearson authored Mar 24, 2023
2 parents 93a067c + 5652b14 commit 16cbd4f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <VERSION_NUMBER> --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 <VERSION_NUMBER>` 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)

0 comments on commit 16cbd4f

Please sign in to comment.