From fb313b92df0d8c293835b27c8c3f77b8a447e372 Mon Sep 17 00:00:00 2001 From: Dan Luhring Date: Mon, 18 Nov 2024 15:49:11 -0500 Subject: [PATCH] docs: re-add release documentation markdown file In uppercase for consistency with the other root-level markdown files. Signed-off-by: Dan Luhring --- RELEASE.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..7a4e00bc6 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,19 @@ +# Melange Release Process + +To cut a release: + +1. Go to https://github.com/chainguard-dev/melange/actions/workflows/release.yaml. +2. Click on the `Run workflow` button. +3. In the dropdown, ensure that the `main` branch is selected. +4. In the dropdown, click on the `Run workflow` button. +5. Wait for the workflow to complete successfully. + +### Useful things to know + +#### Detecting whether a new release is needed + +The release workflow checks to see if there are any changes since the last release. If there are no changes, the workflow will end execution early and not create a new release. + +#### Automatic triggering + +In addition to being triggerable manually (as described at the top of this document), the workflow also runs automatically every Monday at midnight UTC. Just like with manual triggering, if there are no new changes since the last release, the workflow will end early without creating a new release.