Skip to content

Commit 3dca1f7

Browse files
authored
Merge pull request #2771 from camilamacedo86/update-release-doc
📖 update the release doc with missing steps and workarounds
2 parents 6a9cedb + 7c4a0e1 commit 3dca1f7

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

RELEASE.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,12 @@ the process was done to ensure that we have an aligned process under the org (si
3131
1. Create a new tag with the correct version from the new `release-<MAJOR.MINOR>` branch
3232
2. Add the changelog on it and publish. Now, the code source is released !
3333

34-
### Announce the new release:
34+
### Update the website docs (https://book.kubebuilder.io/quick-start.html)
35+
36+
1. Push a PR to update the `book-v3` branch with the changes of the latest release branch created (`release-<MAJOR.MINOR>`)
37+
2. Ping in the [Kubebuilder Slack channel](https://kubernetes.slack.com/archives/CAR30FCJZ) and ask for reviews.
38+
39+
### When the release be done and the website update: Announce the new release:
3540

3641
1. Publish the new release on the Slack channel, i.e:
3742

@@ -44,6 +49,27 @@ For more info, see the release page: https://github.com/kubernetes-sigs/kubebuil
4449

4550
2. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] Kubebuilder $VERSION is released`
4651

52+
## What to do if things goes wrong? How to release from my local env as a workaround?
53+
54+
As a workaround we can release from locally by:
55+
56+
1. Download google container builder: https://github.com/GoogleCloudPlatform/cloud-build-local
57+
2. Verify that you can use the cloud-build-local CLI tool
58+
3. Ensure that you are locally in the branch created for the release (`release-<MAJOR.MINOR>`)
59+
4. Ensure that it has no changes in the code source ( `git status`)
60+
5. Create the directory `cloudbuild` (`mkdir cloudbuild`)
61+
6. Then, update the file `build/cloudbuild_local.yaml` with:
62+
63+
The following change is required for Goreleaser be able to add the binaries in the release page.
64+
65+
```sh
66+
env: ["SNAPSHOT=1","GITHUB_TOKEN=your github token with access in the repo"]
67+
```
68+
**NOTE** You can create a token [here](https://github.com/settings/tokens/new).
69+
70+
7. Then, update the file `build/build_kubebuilder.sh` to remove the flag `--snapshot` (Otherwise, the binaries will be built with snapshot git commit hash instead of the tag version)
71+
8. Run the command to trigger the release `$ cloud-build-local --config=build/cloudbuild_local.yaml --dryrun=false --write-workspace=./cloudbuild .`
72+
4773
## HEAD releases
4874

4975
The binaries releases for HEAD are available here:

0 commit comments

Comments
 (0)