Browse Source

chore(docs): update the release flow (#5358)

Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>

On-behalf-of: Gergely Brautigam <gergely.brautigam@sap.com>
Gergely Brautigam 6 months ago
parent
commit
12a7b8ee62
1 changed files with 19 additions and 5 deletions
  1. 19 5
      docs/contributing/release.md

+ 19 - 5
docs/contributing/release.md

@@ -17,8 +17,22 @@ Otherwise the `latest` documentation will point to the older version. Also avoid
 
 ## Release Helm Chart
 
-1. Update `version` and/or `appVersion` in `Chart.yaml` and run `make helm.docs helm.update.appversion helm.test.update helm.test`
-1. push to branch and open pr
-1. run `/ok-to-test-managed` commands for all cloud providers
-1. merge PR if everything is green
-1. CI picks up the new chart version and creates a new GitHub Release for it
+1. Update `version` and/or `appVersion` in `Chart.yaml` and run `make helm.docs helm.update.appversion helm.test.update docs.update test.crds.update`
+2. push to branch and open pr
+3. run `/ok-to-test-managed` commands for all cloud providers
+4. merge PR if everything is green
+5. CI picks up the new chart version and creates a new GitHub Release for it
+
+The following things are updated with those commands:
+1. Update helm docs
+2. Update the apiVersion in the snapshots for the helm tests
+3. Update all the helm tests with potential added values
+4. Update the stability docs with the latest minor version if exists
+5. Update the CRD conformance tests
+
+The branch to create this release should be `release-chart-x.y.z`. Though be aware that release branches are _immutable_.
+This means that if there is anything that needs to be fixed, a new branch will need to be created.
+
+Also, keep an eye on `main` so nothing is merged while the chart branch is running the e2e tests. If that happens,
+the chart PR CANNOT be merged because we don't allow not up-to-date pull requests to be merged. And you can't update
+because the branch is immutable.