Add basic steps for cutting a release

acryldata · Jun 16, 2023 · 5f82cd7 · 5f82cd7
1 parent 5e5f035
commit 5f82cd7
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/developing.md b/developing.md
@@ -0,0 +1,12 @@
+
+
+TODO Build out a better development guide here.
+
+
+## Releases
+
+When cutting a new release, use GitHub's UI for `Draft a Release`.
+- Do **not** check "publish this action to the GitHub marketplace". The `v1` tag is the only one that should be published there.
+- Set the tag name to be `v1.x.y` - create a new tag on publish.
+
+We have a CI job that will automatically update the clean `v1` tag when the `v1.x.y` tag is published.