Skip to content

Commit 76681e2

Browse files
kranurag7kranurag7
authored andcommitted
add note about updating metadata.yaml
Signed-off-by: kranurag7 <[email protected]>
1 parent dc00bed commit 76681e2

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/develop/releasing.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
This document describes the release process of cluster-stack-operator.
33
The release process is done using GitHub actions. The release workflow triggers when a tag is pushed starting with `v*`
44

5+
> [!NOTE]
6+
> Before the release, please make sure that you've already updated metadata.yaml at the root of the repo. So, if you're using v1.2.0 then you'll also need to update the `releaseSeries` block in metadata.yaml. The tag used for releasing should be compatible with what we have defined in metadata.yaml
7+
58
Creating a new release of cluster-stack-operator covers the following steps:
69

710
### Step 1: Create and Push a tag
@@ -30,4 +33,4 @@ This will automatically trigger a Github workflow to create a draft release in G
3033
> [!WARNING]
3134
> :rotating_light: This is a RELEASE CANDIDATE. If you find any bugs, please file an [issue](https://github.com/SovereignCloudStack/cluster-stack-operator/issues/new).
3235
3. Before publishing the images make sure that images are already there in GitHub container registry. This can be checked in the [packages section](https://github.com/SovereignCloudStack/cluster-stack-operator/pkgs/container/cso) of the organisation.
33-
4. Publish the release.
36+
4. Publish the release.

0 commit comments

Comments
 (0)