Skip to content

Commit 3225d98

Browse files
authored
Update the release procedure (kubernetes#2565)
Seems like the point explaining how to promote images from staging is gone, this commit adds it back, fixes formatting and moves the file into the `docs` directory.
1 parent ea198dd commit 3225d98

File tree

2 files changed

+44
-42
lines changed

2 files changed

+44
-42
lines changed

docs/release-procedure.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Release Procedure
2+
3+
The Cloud Provider OpenStack Release is done in sync with
4+
kubernetes/kubernetes. Minor versions can be released intermittently for
5+
critical bug fixes.
6+
7+
## Making a Release
8+
9+
1. Checkout the release branch.
10+
11+
```bash
12+
$ git fetch upstream
13+
$ git checkout -b my-release upstream/release-X.Y
14+
```
15+
16+
2. Update the minor version with the expected version.
17+
18+
Make changes in the `docs/manifests/tests/examples` directories using the
19+
`hack/bump_release.sh` script by running the following command:
20+
21+
```bash
22+
$ hack/bump-release.sh 28 29 0
23+
```
24+
25+
This will replace `1.28.x`/`2.28.x` with `1.29.0`/`2.29.0` strings in the
26+
`docs/manifests/tests/examples` directories. Ensure that you double-check the
27+
diff before committing the changes. Non-related changes must not be shipped.
28+
29+
3. Create a new pull request (PR) and make sure all CI checks have passed.
30+
31+
4. Once the PR is merged, make a tag and push it to the upstream repository.
32+
33+
```bash
34+
$ git checkout -b release-X.Y upstream/release-X.Y
35+
$ git pull upstream release-X.Y --tags
36+
$ git tag -m "Release for cloud-provider-openstack to support Kubernetes release x" vX.Y.Z
37+
$ git push upstream vX.Y.Z
38+
```
39+
40+
5. [Github Actions](https://github.com/kubernetes/cloud-provider-openstack/actions/workflows/release-cpo.yaml) will create new [Docker images](https://console.cloud.google.com/gcr/images/k8s-staging-provider-os) and generate a [new draft release](https://github.com/kubernetes/cloud-provider-openstack/releases) in the repository.
41+
42+
6. Make PR modifying [images.yaml](https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-provider-os/images.yaml) to promote gcr.io images to registry.k8s.io. The point is to copy the proper image sha256 hashes from the staging repository to the images.yaml.
43+
44+
7. Once images are promoted create release notes using the "Generate release notes" button in the GitHub "New release" UI and publish the release.

release-procedure.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

0 commit comments

Comments
 (0)