From 7e65f4a8eb71ac2dd0e7f69ac9505ccff1f04981 Mon Sep 17 00:00:00 2001 From: Ben Banfield-Zanin Date: Fri, 6 Dec 2024 15:15:34 +0000 Subject: [PATCH 1/2] Have CI create a draft rather than published release --- .github/workflows/releasing.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/releasing.yml b/.github/workflows/releasing.yml index 391d4872..a107a21d 100644 --- a/.github/workflows/releasing.yml +++ b/.github/workflows/releasing.yml @@ -93,6 +93,7 @@ jobs: - name: Release uses: softprops/action-gh-release@v2 with: + draft: true generate_release_notes: true files: charts/matrix-stack/matrix-stack*.tgz* fail_on_unmatched_files: true From d7370e1a94b0df997c662fa27b329329630667c7 Mon Sep 17 00:00:00 2001 From: Ben Banfield-Zanin Date: Fri, 6 Dec 2024 15:15:42 +0000 Subject: [PATCH 2/2] Document how to release --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 451ddd3a..3d93639f 100644 --- a/README.md +++ b/README.md @@ -149,3 +149,18 @@ The individual Helm charts focus on application construction, i.e. it is a flag in the 2nd item in a predefined list. We are not going to expose every single application configuration option. + +## Releasing + +To create a release, just construct a tag with the desired version number. +CI will run a workflow that constructs OCI and tarball artifacts with this version +number. It will then create a draft release. The draft release will have release +notes containing all the PR titles since the last release. Finally the workflow +will then create a version bump the PR; the new version number will increment +only the patch version vs the tag and suffix with `-dev`. + +The draft release can then be editted to adjust the release notes before being +published. + +The tarball artifact will be attached to the release. The OCI artifact will be +available at `oci://ghrc.io/element-hq/ess-helm:`