From 5f82cd7c7e71ecda04a79d412afd2d5ada692e8b Mon Sep 17 00:00:00 2001 From: Harshal Sheth Date: Fri, 16 Jun 2023 13:51:49 -0700 Subject: [PATCH] Add basic steps for cutting a release --- developing.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 developing.md diff --git a/developing.md b/developing.md new file mode 100644 index 0000000..6fcda87 --- /dev/null +++ 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.