You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ For a **MAJOR** or **MINOR** release:
9
9
```shell
10
10
git checkout -b release-x.y main
11
11
```
12
-
> Just creating a release branch without any commits will NOT create release branches for dependent components (cf-api, cf-ui, argo-platform, etc)! Newly created `release-x.y` branch must be updated!
12
+
> **Note!**Just creating a release branch without any commits will NOT create release branches for dependent components (cf-api, cf-ui, argo-platform, etc)! Newly created `release-x.y` branch must be updated!
- Run `./scripts/helm-docs.sh` to update `README.md` files
20
20
- Commit and push changes, trigger CI with `/test` comment, make sure all checks pass, then merge the PR
21
21
- When the PR is merged, the release draft will be created automatically and `codefresh/x.y.z: prepare chart content for release` PR will be opened with the updated chart `.version` and `artifacthub.io/changes` annotation.
22
+
> **Note!** If more changes are required before the release, repeat the steps above by creating a new PR against `release-x.y` branch. Release will not be published until `codefresh/x.y.z: prepare chart content for release` PR is merged!
22
23
- Review `codefresh/x.y.z: prepare chart content for release` PR. Update `artifacthub.io/changes` annotation if needed.
23
24
- Merge the PR to create a new release. Release will be published automatically.
24
25
25
26
For a **PATCH** release:
26
27
28
+
- Create a new branch from the corresponding `release-x.y` branch, where `x.y` is the major and minor version numbers of the release.
29
+
```shell
30
+
git checkout -b patch/something release-x.y
31
+
```
32
+
- Make necessary changes to the chart like updating versions of **required** dependencies in `Chart.yaml`, updating `values.yaml`, `templates/**` files if required and etc.
33
+
> **Note!** If these changes are required for the next major or minor release, make sure to cherry-pick them to the `main` branch as well with a separate PR.
34
+
- Run `./scripts/helm-docs.sh` to update `README.md` files
35
+
- Commit and push changes, open a PR against `release-x.y` branch, trigger CI with `/test` comment, make sure all checks pass, then merge the PR
36
+
- When the PR is merged, the release draft will be created automatically with `codefresh/x.y.z: prepare chart content for release` PR
37
+
- Review `codefresh/x.y.z: prepare chart content for release` PR. Update `artifacthub.io/changes` annotation if needed.
38
+
- Merge the PR to create a new release. Release will be published automatically.
0 commit comments