From e1dfd192e898525eba0fc46020a6ccd0036437f1 Mon Sep 17 00:00:00 2001 From: Max Isom Date: Sun, 18 Aug 2024 16:27:39 -0700 Subject: [PATCH] Add release docs --- RELEASING.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..34d3b81 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,5 @@ +# Releasing + +1. Confirm that CHANGELOG.md is updated (any new changes should go under "Unreleased" at the top). +2. On the master branch, run `yarn release` and follow the prompts. +3. After a new tag is pushed from the above step, the [publish workflow](./.github/workflows/publish.yml) will automatically build & push Docker images and create a GitHub release for the tag.