Skip to content

Commit 0f97b01

Browse files
committed
chore: update release docs and makefile targets
Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
1 parent d30b197 commit 0f97b01

File tree

2 files changed

+29
-17
lines changed

2 files changed

+29
-17
lines changed

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,8 +355,9 @@ release-manifest:
355355
$(MAKE) manifests
356356
@sed -i "s/version: .*/version: ${NEWVERSION}/" manifest_staging/charts/secrets-store-csi-driver/Chart.yaml
357357
@sed -i "s/appVersion: .*/appVersion: ${NEWVERSION}/" manifest_staging/charts/secrets-store-csi-driver/Chart.yaml
358-
@sed -i "s/tag: .*/tag: ${NEWVERSION}/" manifest_staging/charts/secrets-store-csi-driver/values.yaml
359-
@sed -i "s/image tag | .*/image tag | \`${NEWVERSION}\` |/" manifest_staging/charts/secrets-store-csi-driver/README.md
358+
@sed -i "s/tag: v${CURRENTVERSION}/tag: v${NEWVERSION}/" manifest_staging/charts/secrets-store-csi-driver/values.yaml
359+
@sed -i "s/v${CURRENTVERSION}/v${NEWVERSION}/" manifest_staging/charts/secrets-store-csi-driver/README.md
360+
@sed -i "s/driver:v${CURRENTVERSION}/driver:v${NEWVERSION}/" manifest_staging/deploy/secrets-store-csi-driver.yaml manifest_staging/deploy/secrets-store-csi-driver-windows.yaml
360361

361362
.PHONY: promote-staging-manifest
362363
promote-staging-manifest: #promote staging manifests to release dir

docs/RELEASE.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The release process consists of three phases: versioning, building and publishin
66

77
Versioning involves maintaining the following files:
88

9-
- Makefile - the Makefile contains a `VERSION` variable that defines the version of the project.
9+
- Makefile - the Makefile contains a `IMAGE_VERSION` variable that defines the version of the project.
1010
- secrets-store-csi-driver.yaml - the Linux driver deployment yaml that contains the latest release tag image of the project.
1111
- secrets-store-csi-driver-windows.yaml - the Windows driver deployment yaml that contains the latest release tag image of the project.
1212
- `deploy/` dir that contains all the secrets-store-csi-driver resources to be deployed to the cluster including the latest release tag image of the project.
@@ -22,44 +22,55 @@ Publishing involves creating a release tag and creating a new Release on GitHub.
2222
1. Update the version to the semantic version of the new release similar to [this](https://github.com/kubernetes-sigs/secrets-store-csi-driver/pull/251)
2323
1. Commit the changes and push to remote repository to create a pull request
2424

25-
```
25+
```bash
2626
git checkout -b bump-version-<NEW VERSION>
27-
git commit -m "Bump versions for <NEW VERSION"
27+
git commit -m "Bump versions for <NEW VERSION>"
2828
git push <YOUR FORK>
2929
```
30-
31-
1. Once the PR is merged to master, the [prow job](https://testgrid.k8s.io/sig-auth-secrets-store-csi-driver#secrets-store-csi-driver-push-image) is triggered to build and push the new version to staging repo (`gcr.io/k8s-staging-csi-secrets-store/driver`)
32-
1. Once the prow job completes, follow the [instructions](https://github.com/kubernetes/k8s.io/tree/master/k8s.gcr.io#image-promoter) to promote the image to production repo
30+
31+
1. Once the PR is merged to master, the [prow job](https://testgrid.k8s.io/sig-auth-secrets-store-csi-driver#secrets-store-csi-driver-push-image) is triggered to build and push the new version to staging repo (`gcr.io/k8s-staging-csi-secrets-store/driver`)
32+
1. Once the prow job completes, follow the [instructions](https://github.com/kubernetes/k8s.io/tree/master/k8s.gcr.io#image-promoter) to promote the image to production repo
3333
- Run generate script to append the new image to promoter manifest
34+
3435
```bash
3536
k8s.gcr.io/images/k8s-staging-csi-secrets-store/generate.sh > k8s.gcr.io/images/k8s-staging-csi-secrets-store/images.yaml
3637
```
38+
3739
- Preview the changes
40+
3841
```bash
3942
git diff
4043
```
44+
4145
- Commit the changes and push to remote repository to create a pull request
42-
1. Once the image promoter PR is merged, the image will be promoted to prod repo (`us.gcr.io/k8s-artifacts-prod/csi-secrets-store/driver`)
46+
1. Once the image promoter PR is merged, the image will be promoted to prod repo (`k8s.gcr.io/csi-secrets-store/driver`)
4347

4448
## Building and releasing
4549

4650
1. Execute the promote-staging-manifest target to generate patch and promote staging manifest to release
51+
52+
```bash
53+
make promote-staging-manifest NEWVERSION=0.0.12 CURRENTVERSION=0.0.11
4754
```
48-
make promote-staging-manifest NEWVERSION=v0.0.12
49-
```
50-
2. Preview the changes
55+
56+
1. Preview the changes
57+
5158
```bash
5259
git diff
5360
```
54-
3. Commit the changes and push to remote repository to create a pull request
55-
```
61+
62+
1. Commit the changes and push to remote repository to create a pull request
63+
64+
```bash
5665
git checkout -b release-<NEW VERSION>
5766
git commit -a -s -m "release: update manifests and helm chart for <NEW VERSION>"
5867
git push <YOUR FORK>
5968
```
60-
4. Once the PR is merged to master, tag master with release version and push tags to remote repository.
69+
70+
1. Once the PR is merged to master, tag master with release version and push tags to remote repository.
6171
- An [OWNER](https://github.com/kubernetes-sigs/secrets-store-csi-driver/blob/master/OWNERS) runs git tag and pushes the tag with git push
62-
```
72+
73+
```bash
6374
git checkout master
6475
git pull origin master
6576
git tag -a <NEW VERSION> -m '<NEW VERSION>'
@@ -70,4 +81,4 @@ Publishing involves creating a release tag and creating a new Release on GitHub.
7081

7182
1. Create a draft release in GitHub and associate it with the tag that was just created
7283
1. Write the release notes similar to [this](https://github.com/kubernetes-sigs/secrets-store-csi-driver/releases/tag/v0.0.12) and upload all the artifacts from the `deploy/` dir
73-
1. Publish release
84+
1. Publish release

0 commit comments

Comments
 (0)