Skip to content

Commit 533078d

Browse files
committed
Update issue template for new release
Signed-off-by: Lennart Jern <lennart.jern@est.tech>
1 parent fd4c06f commit 533078d

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

.github/ISSUE_TEMPLATE/new_release.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,42 @@ title: Tasks for v<release-tag> release cycle
1010
Tasks for a new release `vX.Y.Z` of the Cluster API Provider OpenStack.
1111
For details, see [RELEASE.md](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/RELEASE.md).
1212

13-
- [ ] [When bumping `X` or `Y`] Create a new release branch called `release-X.Y`.
14-
- [ ] [When bumping `X` or `Y`] Add a new entry of new release branch to [depandabot.yml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/.github/dependabot.yml).
15-
- [ ] [When bumping `X` or `Y`] Add a new entry of new release branch to [security-scan.yaml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/.github/workflows/security-scan.yaml).
13+
### Pre-release tasks
14+
15+
These tasks must be completed for alpha/beta releases.
16+
1617
- [ ] [When bumping `X` or `Y`] Add a new entry to [metadata.yaml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/metadata.yaml)
1718
as [described in the CAPI book](https://cluster-api.sigs.k8s.io/developer/providers/contracts/clusterctl#metadata-yaml)
1819
on the release branch prior to release.
19-
- [ ] Create the PR after generating release notes according to [RELEASE.md](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/RELEASE.md). Verify that the release PR looks good and make changes if necessary. When this PR is merged, release automation will push the tag to upstream and create a draft release notes.
20+
21+
### Release candidate and branch tasks
22+
23+
The first release candidate (`-rc.0`) will trigger the creation of the release branch.
24+
Once this is done, complete the following tasks:
25+
26+
- [ ] [When bumping `X` or `Y`] Add an entry for the new release branch to [depandabot.yml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/.github/dependabot.yml).
27+
- [ ] [When bumping `X` or `Y`] Add an entry for the new release branch to [security-scan.yaml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/.github/workflows/security-scan.yaml).
28+
29+
### Release process
30+
31+
These tasks must be done for each release and pre-release.
32+
33+
- [ ] Create the PR after generating release notes according to [RELEASE.md](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/RELEASE.md). Verify that the release PR looks good and make changes if necessary. When this PR is merged, release automation will push the tag to upstream and create a draft release.
2034
- [ ] Promote the [staging image](https://console.cloud.google.com/cloud-build/builds?project=k8s-staging-capi-openstack) by
2135
adding the new sha=>tag mapping to [images.yaml](https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-capi-openstack/images.yaml).
2236
- [ ] Verify that the new draft release looks good.
2337
- [ ] Verify that the image was promoted sucessfully.
38+
```bash
39+
docker run --rm registry.k8s.io/capi-openstack/capi-openstack-controller:vX.Y.Z --version
40+
```
2441
- [ ] Publish the release.
2542
Mark the release as "latest" if it is the most recent minor release.
2643
E.g. if both v1.1 and v1.2 are supported with patch releases, then only v1.2.z should be marked as "latest".
2744

2845
## Post-release tasks
2946

47+
These tasks can be completed after a release candidate (and branch) is done, or after the final release is out.
48+
3049
- [ ] [When bumping `X` or `Y`] Update the [periodic jobs](https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/cluster-api-provider-openstack).
3150
Make sure there are periodic jobs for the new release branch, and clean up jobs for branches that are no longer supported.
3251
- [ ] [When bumping `X` or `Y`] Update the [clusterctl upgrade tests](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/test/e2e/suites/e2e/clusterctl_upgrade_test.go)

0 commit comments

Comments
 (0)