diff --git a/README.md b/README.md index 9081c656..c3f762d1 100644 --- a/README.md +++ b/README.md @@ -28,3 +28,15 @@ $ yarn link $ cd ../../../../compound-web $ yarn link @types/react ``` + +### Release + +To release a new version of Compound Web: + +1. Review the changes since last released and choose the [appropriate](https://semver.org/) version bump (major, minor, patch). +1. Run the [Release npm package](https://github.com/vector-im/compound-web/actions/workflows/npm_release.yml) action, inputting the version bump. + The action will: + - add a commit bumping the version in `package.json` + - publish the package to npm + - tag a release on Github +1. Manually add a changelog to the [release on github](https://github.com/vector-im/compound-web/releases).