Skip to content

Commit a02b3e6

Browse files
committed
Update RELEASE.md
1 parent 5f544fa commit a02b3e6

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

RELEASE.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,50 @@ be cut at the same time.
1212

1313
The process for both is as follows:
1414

15-
1. An issue is proposing a new release with a changelog since the last release
16-
1. At least two of the [OWNERS](OWNERS) must LGTM this release
15+
1. An issue proposing a new release is opened.
16+
The issue should describe if one or both of the container image and Helm
17+
chart should be released.
18+
- Example issue: https://github.com/kubernetes-sigs/dra-example-driver/issues/119
19+
1. At least two of the [OWNERS](OWNERS) must agree to move forward with this
20+
release.
1721
1. When releasing new container images, the Helm chart's `appVersion` in
1822
Chart.yaml is updated to reflect the version of the images to be cut.
19-
1. Depending on what is being released, an OWNER runs `git tag -a -s $VERSION`
20-
and inserts the changelog and pushes the tag with `git push $VERSION`
23+
- Example PR: https://github.com/kubernetes-sigs/dra-example-driver/pull/120
24+
1. Depending on what is being released, an OWNER runs `git tag -a $VERSION -m $VERSION`
25+
and pushes the tag with `git push <remote> $VERSION`
2126
- When releasing the container images, `$VERSION` is a `v`-prefixed
2227
[SemVer], e.g. `v0.1.0`
2328
- When releasing the Helm chart, `$VERSION` is a `chart/`-prefixed [SemVer],
2429
e.g. `chart/0.1.0`
2530
- The same commit may be tagged with a tag of each form to release both the
26-
Helm chart and container images at the same time
31+
Helm chart and container images at the same time.
32+
- `<remote>` refers to the name of the Git remote for the repo at
33+
[https://github.com/kubernetes-sigs/dra-example-driver], likely either
34+
`upstream` or `origin`
2735
- Each pushed tag triggers builds of artifacts pushed to the staging
2836
repository for the [dra-example-driver container image][container-staging]
29-
and [Helm chart][chart-staging]
30-
1. A PR updating the [registry.k8s.io image list][image-list] is opened with the
31-
SHA digests and tags of the new artifacts from the staging repo
37+
and [Helm chart][chart-staging].
38+
1. When releasing new container images, an OWNER drafts (but does not yet
39+
publish) a [GitHub release][releases] with GitHub's generated release notes.
40+
1. A PR updating the [registry.k8s.io image list][image list] is opened with the
41+
SHA digests and tags of the new artifacts from the staging repo.
3242
- Example PR: https://github.com/kubernetes/k8s.io/pull/7871
33-
1. The artifacts are verified to be available from registry.k8s.io
34-
1. When releasing new container images, an OWNER publishes a GitHub release
35-
1. The release issue is closed
43+
- After the PR merges, a run of the [promotion job] will kick off.
44+
1. The artifacts are verified to be available from registry.k8s.io:
45+
- e.g. the v0.2.0 image and 0.2.0 chart can be verified with the following
46+
commands:
47+
- `docker manifest inspect registry.k8s.io/dra-example-driver/dra-example-driver:v0.2.0`
48+
- `docker manifest inspect registry.k8s.io/dra-example-driver/charts/dra-example-driver:0.2.0`
49+
1. The drafted [GitHub release][releases] is published.
50+
1. The release issue is closed.
3651
1. An announcement is made to [#wg-device-management] on Slack.
52+
- e.g. [https://kubernetes.slack.com/archives/C0409NGC1TK/p1756395401313149]
3753

3854
[SemVer]: https://semver.org/
3955
[staging repo]: https://console.cloud.google.com/artifacts/docker/k8s-staging-images/us-central1/dra-example-driver?inv=1&invt=Abs5-A&project=k8s-staging-images
4056
[chart-staging]: https://console.cloud.google.com/artifacts/docker/k8s-staging-images/us-central1/dra-example-driver/charts%2Fdra-example-driver?inv=1&invt=Abs5-A&project=k8s-staging-images
4157
[container-staging]: https://console.cloud.google.com/artifacts/docker/k8s-staging-images/us-central1/dra-example-driver/dra-example-driver?inv=1&invt=Abs5-A&project=k8s-staging-images
4258
[image list]: https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-dra-example-driver/images.yaml
59+
[promotion job]: https://testgrid.k8s.io/sig-k8s-infra-k8sio#post-k8sio-image-promo
60+
[releases]: https://github.com/kubernetes-sigs/dra-example-driver/releases
4361
[#wg-device-management]: https://kubernetes.slack.com/archives/C0409NGC1TK

0 commit comments

Comments
 (0)