Skip to content

Commit

Permalink
docs: re-add release documentation markdown file
Browse files Browse the repository at this point in the history
In uppercase for consistency with the other root-level markdown files.

Signed-off-by: Dan Luhring <dluhring@chainguard.dev>
  • Loading branch information
luhring committed Nov 18, 2024
1 parent 74eeea4 commit fb313b9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit fb313b9

Please sign in to comment.