From dda7b8ea59d813b088010ba643de3f518fef9009 Mon Sep 17 00:00:00 2001 From: davidmirror-ops Date: Thu, 31 Jul 2025 08:20:38 -0500 Subject: [PATCH] Document release process pt1 Signed-off-by: davidmirror-ops --- RELEASE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..dcc1e8d2a --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,11 @@ +# How flyteconsole releases work? + +This repo uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate version management and packaging of new flyteconsole releases. + +Every time a PR with commit messages including `feat` or `fix` is merged, `semantic-release` will automatically cut a new flyteconsole release. +This can be tracked with [this action](https://github.com/flyteorg/flyteconsole/actions/workflows/checks.yml), specifically the [Generate Release](https://github.com/flyteorg/flyteconsole/blob/acbb626ebdc3fb24040306e42ffcdaada8fc14b3/.github/workflows/checks.yml#L69-L91) step. + +Currently, flyteconsole releases are independent from flyte or flytekit releases, **but there is a caveat**: on every new flyteconsole release, the corresponding packages are pushed to the [flyteconsole GHCR repo](https://github.com/flyteorg/flyteconsole/pkgs/container/flyteconsole). +However, part of the Flyte release process automation includes checking for new flyteconsole releases, pulling the latest from the flyteconsole repo and pushing the package to a different [flyteconsole-release](https://github.com/flyteorg/flyteconsole/pkgs/container/flyteconsole-release/) repo, where many users and customers are used to pull from. + +This means that, in order to sync packages between these two registries, we need to cut a Flyte release AFTER a flyteconsole release is out.