Add generate-release-pr to /hack/release-scripts #1794

AndrewSirenko · 2023-10-20T18:15:24Z

Is this a bug fix or adding new feature?
Release automation

What is this PR about? / Why do we need it?
This PR adds:

generate-release-pr in hack/release-scripts: This script prepares (most of) a post-release PR, including updates to:
- README.md
- docs/install.md
- Makefile
- charts/aws-ebs-csi-driver/Chart.yaml
- Kustomize Overlays

What testing is done?
Running ./generate-release-pr v1.23.1 v1.24.0 on the release-1.23 branch will produce the following diff:

diff --git a/Makefile b/Makefile
index 14381011..b32b030c 100644
--- a/Makefile
+++ b/Makefile
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-VERSION?=v1.23.1
+VERSION?=v1.24.0
 
 PKG=github.com/kubernetes-sigs/aws-ebs-csi-driver
 GIT_COMMIT?=$(shell git rev-parse HEAD)
diff --git a/README.md b/README.md
index c156d5f1..1c23ec64 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,14 @@ The [Amazon Elastic Block Store](https://aws.amazon.com/ebs/) Container Storage
 
 | Driver Version | [registry.k8s.io](https://kubernetes.io/blog/2022/11/28/registry-k8s-io-faster-cheaper-ga/) Image | [ECR Public](https://gallery.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver) Image |
 |----------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
-| v1.23.1        | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.23.1                                           | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.1                      |
+| v1.24.0        | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.24.0                                           | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.24.0                      |
 
 <details>
 <summary>Previous Images</summary>
 
 | Driver Version | [registry.k8s.io](https://kubernetes.io/blog/2022/11/28/registry-k8s-io-faster-cheaper-ga/) Image | [ECR Public](https://gallery.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver) Image |
 |----------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
+| v1.23.1        | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.23.1                                           | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.1                      |
 | v1.23.0        | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.23.0                                           | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.0                      |
 | v1.22.1        | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.22.1                                           | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.22.1                      |
 | v1.22.0        | registry.k8s.io/provider-aws/aws-ebs-csi-driver:v1.22.0                                           | public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.22.0                      |
diff --git a/charts/aws-ebs-csi-driver/Chart.yaml b/charts/aws-ebs-csi-driver/Chart.yaml
index 2dc59f77..09c56ab0 100644
--- a/charts/aws-ebs-csi-driver/Chart.yaml
+++ b/charts/aws-ebs-csi-driver/Chart.yaml
@@ -1,8 +1,8 @@
 apiVersion: v2
-appVersion: 1.23.1
+appVersion: 1.24.0
 name: aws-ebs-csi-driver
 description: A Helm chart for AWS EBS CSI Driver
-version: 2.23.1
+version: 2.24.0
 kubeVersion: ">=1.17.0-0"
 home: https://github.com/kubernetes-sigs/aws-ebs-csi-driver
 sources:
diff --git a/deploy/kubernetes/base/controller.yaml b/deploy/kubernetes/base/controller.yaml
index 1537fb8d..8ebe5469 100644
--- a/deploy/kubernetes/base/controller.yaml
+++ b/deploy/kubernetes/base/controller.yaml
@@ -61,7 +61,7 @@ spec:
         runAsUser: 1000
       containers:
         - name: ebs-plugin
-          image: public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.1
+          image: public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.24.0
           imagePullPolicy: IfNotPresent
           args:
             # - {all,controller,node} # specify the driver mode
diff --git a/deploy/kubernetes/base/node.yaml b/deploy/kubernetes/base/node.yaml
index 830f094e..7b1b12a0 100644
--- a/deploy/kubernetes/base/node.yaml
+++ b/deploy/kubernetes/base/node.yaml
@@ -44,7 +44,7 @@ spec:
         runAsUser: 0
       containers:
         - name: ebs-plugin
-          image: public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.23.1
+          image: public.ecr.aws/ebs-csi-driver/aws-ebs-csi-driver:v1.24.0
           imagePullPolicy: IfNotPresent
           args:
             - node
diff --git a/docs/install.md b/docs/install.md
index 7b7d734a..20afcc18 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -52,7 +52,7 @@ You may deploy the EBS CSI driver via Kustomize, Helm, or as an [Amazon EKS mana
 
 #### Kustomize
 ```sh
-kubectl apply -k "github.com/kubernetes-sigs/aws-ebs-csi-driver/deploy/kubernetes/overlays/stable/?ref=release-1.23"
+kubectl apply -k "github.com/kubernetes-sigs/aws-ebs-csi-driver/deploy/kubernetes/overlays/stable/?ref=release-1.24"

AndrewSirenko · 2023-11-01T15:18:50Z

/retest

torredil

/lgtm

hack/release-scripts/generate-release-pr

torredil · 2023-11-15T19:22:03Z

hack/release-scripts/generate-release-pr

+update_readme () {
+  log "Updating README.md"
+  # vi macro that adds new driver version 'Container Images' row to README.md
+  vi -s <(echo "gg/## Container Images


Could we use sed here for consistency? it would let us remove vi from the dependencies list.

I agree that using sed is preferable to vi, but I was not able to figure out a way to use sed for this operation (after quite some time...).

hack/release-scripts/generate-release-pr

torredil · 2023-11-15T20:10:23Z

hack/release-scripts/generate-release-pr

+  2. Update CHANGELOG.md
+  3. Update charts/aws-ebs-csi-driver/CHANGELOG.md"


Idea: It might help to list all the relevant commits that a maintainer has to consider when crafting the CHANGELOG for a particular release.

Great idea!

I actually showcased a script that does this during a demo a few months ago (and have been using it during releases). I should clean that script up and commit it to our repo, but I think that should be a separate PR.

Found it! Here

github-actions · 2023-11-25T01:02:24Z

Code Coverage Diff

This PR does not change the code coverage

torredil

/lgtm
/approve

k8s-ci-robot · 2023-12-01T19:40:21Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: torredil

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [torredil]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot requested a review from ConnorJC3 October 20, 2023 18:15

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 20, 2023

k8s-ci-robot requested a review from torredil October 20, 2023 18:15

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 20, 2023

AndrewSirenko force-pushed the addGenerateReleasePr branch 2 times, most recently from 7b35b6e to b35fb9c Compare October 26, 2023 15:13

ConnorJC3 force-pushed the master branch 2 times, most recently from 24a8e7b to bddbe0b Compare November 1, 2023 18:08

torredil approved these changes Nov 15, 2023

View reviewed changes

k8s-ci-robot assigned torredil Nov 15, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 15, 2023

AndrewSirenko force-pushed the addGenerateReleasePr branch from b35fb9c to 51a6d12 Compare November 25, 2023 00:56

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 25, 2023

Add generate-release-pr to /hack/release-scripts

d58f82f

AndrewSirenko force-pushed the addGenerateReleasePr branch from 51a6d12 to d58f82f Compare November 25, 2023 01:02

AndrewSirenko requested a review from torredil November 25, 2023 01:03

torredil approved these changes Dec 1, 2023

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 1, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 1, 2023

k8s-ci-robot merged commit 551b59a into kubernetes-sigs:master Dec 1, 2023
19 checks passed

AndrewSirenko deleted the addGenerateReleasePr branch December 5, 2023 15:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add generate-release-pr to /hack/release-scripts #1794

Add generate-release-pr to /hack/release-scripts #1794

AndrewSirenko commented Oct 20, 2023

AndrewSirenko commented Nov 1, 2023

torredil left a comment

torredil Nov 15, 2023

AndrewSirenko Nov 16, 2023

torredil Nov 15, 2023

AndrewSirenko Nov 24, 2023

AndrewSirenko Nov 25, 2023

github-actions bot commented Nov 25, 2023

torredil left a comment

k8s-ci-robot commented Dec 1, 2023

		2. Update CHANGELOG.md
		3. Update charts/aws-ebs-csi-driver/CHANGELOG.md"

Add generate-release-pr to /hack/release-scripts #1794

Add generate-release-pr to /hack/release-scripts #1794

Conversation

AndrewSirenko commented Oct 20, 2023

AndrewSirenko commented Nov 1, 2023

torredil left a comment

Choose a reason for hiding this comment

torredil Nov 15, 2023

Choose a reason for hiding this comment

AndrewSirenko Nov 16, 2023

Choose a reason for hiding this comment

torredil Nov 15, 2023

Choose a reason for hiding this comment

AndrewSirenko Nov 24, 2023

Choose a reason for hiding this comment

AndrewSirenko Nov 25, 2023

Choose a reason for hiding this comment

github-actions bot commented Nov 25, 2023

Code Coverage Diff

torredil left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 1, 2023