Skip to content

Commit c879f47

Browse files
update RELEASE.md
1 parent 3d9d250 commit c879f47

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

RELEASE.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For a **MAJOR** or **MINOR** release:
99
```shell
1010
git checkout -b release-x.y main
1111
```
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!
1313
- Open a PR against `release-x.y` branch
1414
```shell
1515
git checkout -b update-release-x.y release-x.y
@@ -19,10 +19,22 @@ git checkout -b update-release-x.y release-x.y
1919
- Run `./scripts/helm-docs.sh` to update `README.md` files
2020
- Commit and push changes, trigger CI with `/test` comment, make sure all checks pass, then merge the PR
2121
- 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!
2223
- Review `codefresh/x.y.z: prepare chart content for release` PR. Update `artifacthub.io/changes` annotation if needed.
2324
- Merge the PR to create a new release. Release will be published automatically.
2425

2526
For a **PATCH** release:
2627

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.
2739

2840
## Versioning in CI and Promote pipelines

0 commit comments

Comments
 (0)