add a release doc

testdouble · Jul 27, 2022 · e73ef13 · e73ef13
1 parent e000fb3
commit e73ef13
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,18 @@
+# Cutting Releases
+
+To cut a new release, first make sure the git working directory is clear and
+then ensure the full suite of tests are passing:
+
+```
+$ npm run test:ci
+```
+
+We use some `preversion` and `postversion` script hooks to automate git & npm
+pushing (and another round of testing), so to bump version and publish in one
+go:
+
+```
+$ npm version patch
+```
+
+Same goes for `npm version minor` and `major`, naturally.