Browse Source

docs: Update release process (#5980)

Co-authored-by: Gergely Bräutigam <gergely.brautigam@sap.com>
Jean-Philippe Evrard 1 month ago
parent
commit
3ddfa7c6fc
1 changed files with 1 additions and 0 deletions
  1. 1 0
      docs/contributing/release.md

+ 1 - 0
docs/contributing/release.md

@@ -31,6 +31,7 @@ When doing a release it's best to start with  with the ["Create Release" issue t
 ⚠️ Note: when releasing multiple versions, make sure to first release the "old" version, then the newer version.
 Otherwise the `latest` documentation will point to the older version. Also avoid to release both versions at the same time to avoid race conditions in the CI pipeline (updating docs, GitHub Release, helm chart release).
 
+1. Make sure there is no pending CI jobs running. This is to avoid promoting a stale image to a new version (we need to rely on _existing_ pushed images for release).
 1. Run `Create Release` Action to create a new release, pass in the desired version number to release.
     1. choose the right `branch` to execute the action: use `main` when creating a new release.
     2. ⚠️ make sure that CI on the relevant branch has completed the docker build/push jobs. Otherwise an old image will be promoted.