Skip to content

Commit 98cd526

Browse files
Improve cutting a release notes with more examples
Signed-off-by: Furkat Gofurov ([email protected])
1 parent ef3c5c4 commit 98cd526

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/release/release-tasks.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,15 +215,18 @@ to a newer Go minor version according to our [backport policy](./../../CONTRIBUT
215215
make promote-images
216216
```
217217
**Notes**:
218+
* `make promote-images` target tries to figure out your Github user handle in order to find the forked [k8s.io](https://github.com/kubernetes/k8s.io) repository.
219+
If you have not forked the repo, please do it before running the Makefile target.
220+
* if `make promote-images` fails with an error like `FATAL while checking fork of kubernetes/k8s.io` you may be able to solve it by manually setting the USER_FORK variable i.e. `export USER_FORK=<personal GitHub handle>`
218221
* `kpromo` uses `[email protected]:...` as remote to push the branch for the PR. If you don't have `ssh` set up you can configure
219222
git to use `https` instead via `git config --global url."https://github.com/".insteadOf [email protected]:`.
220223
* This will automatically create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the CAPI maintainers.
221224
4. Merge the PR (/lgtm + /hold cancel) and verify the images are available in the production registry:
222225
* Wait for the [promotion prow job](https://prow.k8s.io/?repo=kubernetes%2Fk8s.io&job=post-k8sio-image-promo) to complete successfully. Then test the production images are accessible:
223226
```bash
224-
docker pull registry.k8s.io/cluster-api/clusterctl:${RELEASE_TAG}
225-
docker pull registry.k8s.io/cluster-api/cluster-api-controller:${RELEASE_TAG}
226-
docker pull registry.k8s.io/cluster-api/kubeadm-bootstrap-controller:${RELEASE_TAG}
227+
docker pull registry.k8s.io/cluster-api/clusterctl:${RELEASE_TAG} &&
228+
docker pull registry.k8s.io/cluster-api/cluster-api-controller:${RELEASE_TAG} &&
229+
docker pull registry.k8s.io/cluster-api/kubeadm-bootstrap-controller:${RELEASE_TAG} &&
227230
docker pull registry.k8s.io/cluster-api/kubeadm-control-plane-controller:${RELEASE_TAG}
228231
```
229232
4. Publish the release in GitHub:
@@ -233,6 +236,8 @@ to a newer Go minor version according to our [backport policy](./../../CONTRIBUT
233236
<br>**Notes**:
234237
* This is only done for new latest stable releases, not for beta / RC releases and not for previous release branches.
235238
* Check if homebrew already has a PR to update the version (homebrew introduced automation that picks it up). Open one if no PR exists.
239+
* To open a PR, you need two things: `tag` (i.e v1.4.2 & v1.3.7 releases are being published, where release-1.4 is the latest stable release branch, so tag would be v1.4.2) and `revision` (it is a commit hash of the tag, i.e if the tag is v1.4.2, it can be found by looking for commit id in [v1.4.2 tag page](https://github.com/kubernetes-sigs/cluster-api/releases/tag/v1.4.2)).
240+
* Once the PR is open, no action should be needed. Homebrew bot should push a second commit (see an example [here](https://github.com/Homebrew/homebrew-core/pull/129986/commits/0da6edddf1143aa50033f7e8ae1ebd07ecdd0941)) to the same PR to update the binary hashes automatically.
236241
* For an example please see: [PR: clusterctl 1.1.5](https://github.com/Homebrew/homebrew-core/pull/105075/files).
237242
* Homebrew has [conventions for commit messages](https://docs.brew.sh/Formula-Cookbook#commit) usually
238243
the commit message for us should look like: `clusterctl 1.1.5`.

0 commit comments

Comments
 (0)