[Release Automation] Update Helm/SDK/Install Packages Version Numbers #3149

Kalaiselvi84 · 2023-05-12T20:13:33Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup
/kind documentation
/kind feature
/kind hotfix

/kind feature

What this PR does / Why we need it:
Scripts to increment version numbers in helm/sdk/install packages before and after release.

Which issue(s) this PR fixes:

Closes #2456

Special notes for your reviewer:

agones-bot · 2023-05-12T20:20:30Z

Build Failed 😱

Build Id: e5428ae0-c345-4a8f-a186-86bcc166806a

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

zmerlynn · 2023-05-12T20:31:35Z

build/scripts/version-update/after-release/after-release.go

+	"strings"
+)
+
+func main() {


rather than the heavy duplication between after-release and before-release, I would recommend using a flag. For a script like this, no worries using the standard flag library: https://pkg.go.dev/flag

Examples in our repo include: https://github.com/googleforgames/agones/blob/main/examples/simple-game-server/main.go#L41-L49

I have updated the code to make it a single script using Flag. Thanks!

zmerlynn · 2023-05-12T20:33:36Z

build/scripts/version-update/after-release/after-release.go

+
+func main() {
+	if len(os.Args) < 2 {
+		fmt.Println("Please provide the initial version as a command-line argument")


log.Fatalf here

used log instead fmt package

zmerlynn · 2023-05-12T20:33:38Z

build/scripts/version-update/after-release/after-release.go

+	for _, filename := range files {
+		err := UpdateVersionInFile(filename, initialVersion)
+		if err != nil {
+			fmt.Printf("Error updating file %s: %s\n", filename, err.Error())


maybe a log.Fatalf instead of just a Printf?

used log instead fmt

zmerlynn · 2023-05-12T20:36:52Z

build/scripts/version-update/after-release/after-release.go

+	// Check the file extension and update version accordingly
+	ext := filepath.Ext(filename)
+	switch ext {
+	case ".yaml", ".yml", ".nuspec", ".csproj":


I'm not sure this needs a case statement. It seems like you can just write it as

if ext := filepath.Ext(filename); ext == ".json" { updateJSONVersion() } else { updateVersion() }

I tried to update the JSON files without a switch/case statement, but the syntax was slightly different. So created a switch/case statement to ensure that the files were updated correctly.

zmerlynn · 2023-05-12T20:39:54Z

build/scripts/version-update/after-release/after-release.go

+	return re.ReplaceAllString(content, newVersion+"-dev")
+}
+
+func updateJSONVersion(content string, initialVersion string) string {


It seems like the only difference here is handling "1.2.3" vs 1.2.3, is that right?

yes that's correct

agones-bot · 2023-05-12T21:02:22Z

Build Failed 😱

Build Id: 9c658717-ef7c-41d8-8ede-2d663a72f058

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-12T23:47:06Z

Build Failed 😱

Build Id: 984ac6f7-e2ce-49d7-9584-8f392c4d1419

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-12T23:58:52Z

Build Failed 😱

Build Id: cb3cfbff-b8ad-433b-8a9d-d371a77a434a

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-13T00:32:17Z

Build Failed 😱

Build Id: 03a4e914-e855-4ee8-81d3-f9352898c069

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

zmerlynn · 2023-05-15T19:39:06Z

build/scripts/version-update/main.go

+var releaseType string
+
+func init() {
+	flag.StringVar(&releaseType, "type", "", "Specify the release type ('before' or 'after')")


Maybe release-stage instead of type (and change variables)? releaseType seems like it should be what type of release it is, vs what stage the release is in.

Renamed type to release-stage and releaseType to releaseStage.

zmerlynn · 2023-05-15T19:43:27Z

build/scripts/version-update/main.go

+		return
+	}
+
+	releaseType := os.Args[1]


The way you are parsing this right now seems to ignore the flags - instead it looks like you would execute it via version-update before 1.2.3, vs version-update --type=before 1.2.3.

Since you are using the flag package, you should trust that the flag package can parse. For non-flag arguments, you should use flag.Args .. so line 23 should be if len(flag.Args()) < 1, for instance.

releaseType is already initialized in init() above, so you don't need this line at all, and the line below should just be initialVersion := flag.Args()[0].

I have updated the code and passed the --release-stage=before flag from the command line.

zmerlynn · 2023-05-15T19:48:38Z

build/scripts/version-update/main.go

+	}
+}
+
+func UpdateValueInFileBeforeRelease(filename string, valueToUpdate string) error {


There is a lot of duplication in the BeforeRelease and AfterRelease variants - you should be able to factor these together. Consider that all this really is is "replace regexp with value" and what you need is a function that takes a regexp and replaces - the regexp and replacement value are the parameters. Then you can set those parameters based on whether it's before/after and whether it's JSON, which seems to be the only differences.

I tried my best to avoid the duplication😀

Please let me know if there are any areas of the code that you think could be improved. Thanks!

agones-bot · 2023-05-15T21:31:44Z

Build Failed 😱

Build Id: 2c613159-cd04-4be1-bb77-8941b9105be0

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-15T21:37:07Z

Build Failed 😱

Build Id: f6f49340-babd-4b6d-8c19-96006cd9cc62

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

zmerlynn

Getting close!

zmerlynn · 2023-05-15T23:38:18Z

build/scripts/version-update/main.go

+	content := string(fileBytes)
+
+	ext := filepath.Ext(filename)
+	validExtensions := []string{".yaml", ".yml", ".nuspec", ".csproj"}


I would eliminate this and just change the below to if ext == ".json" - you're adding some amount of complexity just to validate a list that is more or less a constant, 20 lines previous to this.

Eliminating this will allow you to eliminate the logic in lines 62-72 and 86-90 as well - it seems like we're going through a lot of effort there.

Updated the code and it looks simple now. Thanks Zach!

agones-bot · 2023-05-16T00:25:32Z

Build Failed 😱

Build Id: 778fe745-90c0-46ee-9321-08d56ef13e73

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

google-oss-prow · 2023-05-16T00:56:40Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Kalaiselvi84, zmerlynn
Once this PR has been reviewed and has the lgtm label, please assign roberthbailey for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

gongmax · 2023-05-16T17:58:28Z

build/scripts/version-update/main.go

+
+import (
+	"flag"
+	"io/ioutil"


linter failed: SA1019: "io/ioutil" has been deprecated since Go 1.19: As of Go 1.16, the same functionality is now provided by package io or package os, and those implementations should be preferred in new code. See the specific function documentation for details. (staticcheck)

replaced io/ioutil with os👍🏻

google-oss-prow · 2023-05-16T18:19:54Z

New changes are detected. LGTM label has been removed.

agones-bot · 2023-05-16T18:25:48Z

Build Failed 😱

Build Id: bec7bfa5-ac87-4c34-938e-ece6bca0b1d6

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-16T23:39:22Z

Build Failed 😱

Build Id: ebe0670a-d4c4-4a86-9337-1a132e9bb991

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-17T00:14:53Z

Build Failed 😱

Build Id: cd58622f-90cf-4fa8-a8e0-ee32a53d098b

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2023-05-17T04:15:48Z

Build Succeeded 👏

Build Id: 99bed0af-37ae-461a-8087-e0f8d9703a53

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.32.0-a7a2eb3-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.32.0-a7a2eb3-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.32.0-a7a2eb3-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.32.0-a7a2eb3-amd64
Linux C++ SDK (build): agonessdk-1.32.0-a7a2eb3-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.32.0-a7a2eb3-amd64.zip

A preview of the website (the last 30 builds are retained):

https://a7a2eb3-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3149/head:pr_3149 && git checkout pr_3149
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.32.0-a7a2eb3-amd64

[Release Automation] Update Helm/SDK/Install Packages Version Numbers

7d9cc5c

Kalaiselvi84 requested review from zmerlynn and roberthbailey May 12, 2023 20:13

google-oss-prow bot requested a review from markmandel May 12, 2023 20:13

google-oss-prow bot added the size/L label May 12, 2023

zmerlynn requested changes May 12, 2023

View reviewed changes

google-oss-prow bot assigned zmerlynn May 12, 2023

updated release_issue.md

b7836b6

version update in helm/sdk/install packages using flag

34e9a3f

updated release_issue.md

477a7fa

updated release_issue.md

4979cab

zmerlynn reviewed May 15, 2023

View reviewed changes

Kalaiselvi84 added 2 commits May 15, 2023 21:24

Refine the code

bd6171c

release_issue.md update

eb00496

zmerlynn reviewed May 15, 2023

View reviewed changes

Better code

5a07622

zmerlynn approved these changes May 16, 2023

View reviewed changes

google-oss-prow bot added the lgtm label May 16, 2023

gongmax reviewed May 16, 2023

View reviewed changes

replace io/ioutil with os

b6676f4

google-oss-prow bot removed the lgtm label May 16, 2023

required update from the build log

4cc2ef9

Updated based on log

4f9c804

Kalaiselvi84 added 2 commits May 17, 2023 02:44

Update based on log

8aafd11

Merge branch 'main' into issues/280493072

a7a2eb3

gongmax merged commit e84215d into googleforgames:main May 17, 2023

Kalaiselvi84 added the kind/feature New features for Agones label May 18, 2023

This was referenced Nov 29, 2023

[Snyk] Fix for 13 vulnerabilities WontonSam/Phiahplay-#7

Open

[Snyk] Fix for 1 vulnerabilities WontonSam/Phiahplay-#9

Open

WontonSam mentioned this pull request Dec 20, 2023

[Snyk] Fix for 8 vulnerabilities WontonSam/Phiahplay-#11

Open

Kalaiselvi84 deleted the issues/280493072 branch March 15, 2024 01:20

WontonSam mentioned this pull request May 21, 2024

[Snyk] Security upgrade node-sass from 5.0.0 to 7.0.2 WontonSam/Phiahplay-#21

Open

[Release Automation] Update Helm/SDK/Install Packages Version Numbers #3149

[Release Automation] Update Helm/SDK/Install Packages Version Numbers #3149

Conversation

Kalaiselvi84 commented May 12, 2023 • edited Loading

agones-bot commented May 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented May 12, 2023

agones-bot commented May 12, 2023

agones-bot commented May 12, 2023

agones-bot commented May 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented May 15, 2023

agones-bot commented May 15, 2023

zmerlynn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented May 16, 2023

google-oss-prow bot commented May 16, 2023

gongmax May 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-oss-prow bot commented May 16, 2023

agones-bot commented May 16, 2023

agones-bot commented May 16, 2023

agones-bot commented May 17, 2023

agones-bot commented May 17, 2023

Kalaiselvi84 commented May 12, 2023 •

edited

Loading

gongmax May 16, 2023 •

edited

Loading