Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit e26305c

Browse files
nojnhuhkeithmattix
authored andcommitted
fix(doc): update release guide (#4661)
- Backported changes should be included before images are published - Clarification on version updates Signed-off-by: Jon Huhn <[email protected]>
1 parent 63786fd commit e26305c

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/release_guide.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Once an RC has been found to be stable, cut a release tagged `vX.Y.Z` using the
1515
- [Release Guide](#release-guide)
1616
- [Release Candidates](#release-candidates)
1717
- [Create a release branch](#create-a-release-branch)
18+
- [Add changes to be backported](#add-changes-to-be-backported)
1819
- [Create and push the pre-release Git tag](#create-and-push-the-pre-release-git-tag)
1920
- [Update release branch with patches and versioning changes](#update-release-branch-with-patches-and-versioning-changes)
2021
- [Create and push the release Git tag](#create-and-push-the-release-git-tag)
@@ -43,9 +44,15 @@ Push the release branch to the upstream repo (NOT forked), identified here by th
4344
$ git push upstream release-<version> # ex: git push upstream release-v0.4
4445
```
4546

47+
## Add changes to be backported
48+
49+
Create a new branch off of the release branch to maintain updates specific to the new version. Let's call it the patch branch. The patch branch should not be created in the upstream repo.
50+
51+
If there are other commits on the `main` branch to be included in the release (such as for successive release candidates or patch releases), cherry-pick those onto the patch branch.
52+
4653
## Create and push the pre-release Git tag
4754

48-
The pre-release Git tag publishes the OSM control plane images to the Openservicemesh container registry in Dockerhub, and publishes the image digests as an artifact of the pre-release Github workflow. The image digests must be used in the next step to update the default control plane image referenced in the Helm charts.
55+
The pre-release Git tag publishes the OSM control plane images to the `openservicemesh` organization in Dockerhub, and publishes the image digests as an artifact of the pre-release Github workflow. The image digests must be used in the next step to update the default control plane image referenced in the Helm charts.
4956

5057
The pre-release Git tag is of the form `pre-rel-<release-version>`, e.g. `pre-rel-v0.4.0`.
5158

@@ -68,14 +75,10 @@ osm-bootstrap: sha256:fd159fdb965cc0d3d7704afaf673862b5e92257925fc3f6345810f98bb
6875

6976
## Update release branch with patches and versioning changes
7077

71-
Create a new branch off of the release branch to maintain updates specific to the new version. Let's call it the patch branch. The patch branch should not be created in the upstream repo.
72-
73-
If there are other commits on the `main` branch to be included in the release (such as for successive release candidates or patch releases), cherry-pick those onto the patch branch.
74-
7578
Create a new commit on the patch branch to update the hardcoded version information in the following locations:
7679

77-
* The control plane image digests defined by `osm.image.digest` for images in [charts/osm/values.yaml](/charts/osm/values.yaml) from the image digests obtained from the Pre-release workflow. For example, if the osm-controller image digest is `sha256:eb194138abddbe271d42b290489917168a6a891a3dabb575de02c53f13879bee`, update the value of `osm.image.digest.osmController` to `sha256:eb194138abddbe271d42b290489917168a6a891a3dabb575de02c53f13879bee`.
78-
* Replace the `latest-main` tag with the release version tag for all images throughout the repo, e.g. `v0.4.0`. This includes updating the image references in `charts/osm` folder.
80+
* The control plane image digests defined by `osm.image.digest` for images in [charts/osm/values.yaml](/charts/osm/values.yaml) from the image digests obtained from the Pre-release workflow. For example, if the osm-controller image digest is `sha256:eb194138abddbe271d42b290489917168a6a891a3dabb575de02c53f13879bee`, update the value of `osm.image.digest.osmController` to `sha256:eb194138abddbe271d42b290489917168a6a891a3dabb575de02c53f13879bee`.
81+
- Ensure the value for `osm.image.tag` in [charts/osm/values.yaml](/charts/osm/values.yaml) is set to the empty string.
7982
* The chart and app version in [charts/osm/Chart.yaml](/charts/osm/Chart.yaml) to the release version.
8083
* The Helm chart [README.md](/charts/osm/README.md)
8184
- Necessary changes should be made automatically by running `make chart-readme`

0 commit comments

Comments
 (0)