Skip to content

Commit 29f8e12

Browse files
authored
Merge pull request #2530 from Nordix/lentzi90/release-docs
📖 Update release docs with the automated release workflow
2 parents 3fc544b + aec0f96 commit 29f8e12

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

RELEASE.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ The content of the release notes differs depending on the type of release, speci
6060

6161
This will cause the image to be automatically built by CI and pushed to the staging repository. As this only builds
6262
the image, it only takes a few minutes.
63+
It also triggers the [release](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/.github/workflows/release.yaml) workflow which will generate release notes and artifacts, and create a draft release in GitHub.
6364
1. Follow the [image promotion process](https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/README.md#image-promoter) to promote the image from the staging repo to `registry.k8s.io/capi-openstack`.
6465
The staging repository can be inspected at https://console.cloud.google.com/gcr/images/k8s-staging-capi-openstack/GLOBAL. Be
6566
sure to choose the top level `capi-openstack-controller`, which will provide the multi-arch manifest, rather than one for a specific architecture.
@@ -68,20 +69,9 @@ The content of the release notes differs depending on the type of release, speci
6869

6970
It is good practise to get somebody else to review this PR. It is safe to perform the following steps while waiting
7071
for review and the promotion of the image.
71-
1. Run `make release` to build artifacts to be attached to the GitHub release.
72-
1. Generate and finalize the release notes and save them for the next step.
73-
- Run `make release-notes`.
74-
- Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted.
75-
1. Create a draft release in GitHub based on the tag created above
76-
- Name the release `Release [VERSION]` where VERSION is the full version string.
77-
- For a pre-release, ensure you check `This is a pre-release` in GitHub when creating the release.
78-
- Add the release notes generated above as the release description.
79-
1. Attach the following files to the draft release:
80-
- `./out/infrastructure-components.yaml`
81-
- `./out/cluster-template.yaml`
82-
- `./out/cluster-template-without-lb.yaml`
83-
- `./out/cluster-template-flatcar.yaml`
84-
- `./out/metadata.yaml`
72+
1. Check carefully the [draft release](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/releases)
73+
created by the workflow. Ensure that the release notes are correct and that the artifacts are present.
74+
If any changes are needed, edit the release notes in the GitHub UI and add any missing artifacts.
8575
1. Ensure that the release image has been promoted.
8676
1. Publish release.
8777

0 commit comments

Comments
 (0)