📝 Add release instructions

open-formulieren · Oct 30, 2023 · 980c360 · 980c360
1 parent ac53273
commit 980c360
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -70,3 +70,18 @@ import {
   PrefillConfig,
 } from '@open-formulieren/types';
 ```
+
+## Release flow
+
+We don't let `npm` apply the git tags when releasing a new version, instead follow this process:
+
+```bash
+npm version --no-git-tag-version minor
+git commit -am ":bookmark: Bump to version <newVersion>"
+git tag "<newVersion>"
+git push origin main --tags
+```
+
+If you have PGP keys set up, you can use them for the git tag operation.
+
+The CI pipeline will then publish the new version to npmjs.