Merge pull request #14 from samkim/release-doc

Add release instructions
authzed · Nov 3, 2021 · b23c56d · b23c56d
2 parents 70b4622 + fb870f6
commit b23c56d
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -114,3 +114,14 @@ You can regenerate the code by executing `buf.gen.yaml`:
 ```sh
 ./buf.gen.yaml
 ```
+
+### Creating a new release
+
+Releases are published to NPM using a GitHub action.
+
+To create a new release:
+1. Use the [yarn version] command to bump the package version.
+1. Create a new [release on GitHub] to initiate the release action.
+
+[yarn version]: https://yarnpkg.com/cli/version
+[release on GitHub]: https://github.com/authzed/authzed-node/releases