Skip to content

Commit 71ff3d9

Browse files
Merge pull request #243 from SgtCoDFish/update-images
Update other images, add release note section
2 parents 55c2d89 + 5480f36 commit 71ff3d9

File tree

4 files changed

+33
-9
lines changed

4 files changed

+33
-9
lines changed

RELEASE.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@ The release schedule for this project is ad-hoc. Given the pre-1.0 status of the
88

99
There is a semi-automated release process for this project. When you create a Git tag with a tagname that has a `v` prefix and push it to GitHub it will trigger the [release workflow].
1010

11+
### Preparing for a Release
12+
13+
**BEFORE** doing a release, check if the other images in the csi-driver Helm
14+
chart need to be updated.
15+
16+
These are:
17+
18+
- registry.k8s.io/sig-storage/livenessprobe (`.Values.livenessProbeImage.tag`)
19+
- registry.k8s.io/sig-storage/csi-node-driver-registrar (`.Values.nodeDriverRegistrarImage.tag`)
20+
21+
The latest image can be checked using `crane`:
22+
23+
```console
24+
$ crane ls registry.k8s.io/sig-storage/livenessprobe | sort -V
25+
26+
$ crane ls registry.k8s.io/sig-storage/csi-node-driver-registrar | sort -V
27+
```
28+
29+
### Doing a Release
30+
1131
The release process for this repo is documented below:
1232

1333
1. Create a tag for the new release:
@@ -16,23 +36,27 @@ The release process for this repo is documented below:
1636
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
1737
git push origin "${VERSION}"
1838
```
39+
1940
2. A GitHub action will see the new tag and do the following:
2041
- Build and publish any container images
2142
- Build and publish the Helm chart
2243
- Create a draft GitHub release
44+
2345
3. Wait for the PR to be merged and wait for OCI Helm chart to propagate and become available from https://charts.jetstack.io (this might take a few hours).
46+
2447
4. Visit the [releases page], edit the draft release, click "Generate release notes", then edit the notes to add the following to the top
2548
```
2649
csi-driver-spiffe is a clean and simple way to get SPIFFE IDs for your Kubernetes pods with minimal dependencies and minimal fuss.
2750
```
51+
2852
5. Publish the release.
2953
3054
## Artifacts
3155
3256
This repo will produce the following artifacts each release. For documentation on how those artifacts are produced see the "Process" section.
3357
34-
- *Container Images* - Container images for the are published to `quay.io/jetstack`.
58+
- *Container Images* - Container images for the are published to `quay.io/jetstack`.
3559
- *Helm chart* - An official Helm chart is maintained within this repo and published to `quay.io/jetstack` and `charts.jetstack.io` on each release.
3660
3761
[release workflow]: https://github.com/cert-manager/csi-driver-spiffe/actions/workflows/release.yaml
38-
[releases page]: https://github.com/cert-manager/csi-driver-spiffe/releases
62+
[releases page]: https://github.com/cert-manager/csi-driver-spiffe/releases

deploy/charts/csi-driver-spiffe/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Target image repository.
256256
#### **app.driver.nodeDriverRegistrarImage.tag** ~ `string`
257257
> Default value:
258258
> ```yaml
259-
> v2.12.0
259+
> v2.13.0
260260
> ```
261261

262262
Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.
@@ -297,7 +297,7 @@ Target image repository.
297297
#### **app.driver.livenessProbeImage.tag** ~ `string`
298298
> Default value:
299299
> ```yaml
300-
> v2.12.0
300+
> v2.15.0
301301
> ```
302302

303303
Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.

deploy/charts/csi-driver-spiffe/values.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@
312312
"type": "string"
313313
},
314314
"helm-values.app.driver.livenessProbeImage.tag": {
315-
"default": "v2.12.0",
315+
"default": "v2.15.0",
316316
"description": "Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.",
317317
"type": "string"
318318
},
@@ -356,7 +356,7 @@
356356
"type": "string"
357357
},
358358
"helm-values.app.driver.nodeDriverRegistrarImage.tag": {
359-
"default": "v2.12.0",
359+
"default": "v2.13.0",
360360
"description": "Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.",
361361
"type": "string"
362362
},

deploy/charts/csi-driver-spiffe/values.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ app:
130130
# Override the image tag to deploy by setting this variable.
131131
# If no value is set, the chart's appVersion is used.
132132
# +docs:property
133-
tag: v2.12.0
133+
tag: v2.13.0
134134

135135
# Target image digest. Override any tag, if set.
136136
# For example:
@@ -155,7 +155,7 @@ app:
155155
# Override the image tag to deploy by setting this variable.
156156
# If no value is set, the chart's appVersion is used.
157157
# +docs:property
158-
tag: v2.12.0
158+
tag: v2.15.0
159159

160160
# Target image digest. Override any tag, if set.
161161
# For example:
@@ -282,4 +282,4 @@ openshift:
282282
# +docs:type=boolean,string,null
283283
enabled: detect
284284
# Name of the SecurityContextConstraints to create RBAC for.
285-
name: privileged
285+
name: privileged

0 commit comments

Comments
 (0)