From c96f3659d9bae3509453c841de53c1579eeefa7d Mon Sep 17 00:00:00 2001
From: Cameron Rozean <rcrozean@amazon.com>
Date: Wed, 10 Jan 2024 12:37:45 -0800
Subject: [PATCH] Update eksGoRelease readme guide (#1307)

* update eksGoRelease readme guide

* add build command to readme

---------

Co-authored-by: EKS Distro PR Bot <aws-model-rocket-bots+eksdistroprbot@amazon.com>
---
 .../cmd/eksGoRelease/README.md                | 50 +++++++++++++++----
 1 file changed, 41 insertions(+), 9 deletions(-)

diff --git a/tools/eksDistroBuildToolingOpsTools/cmd/eksGoRelease/README.md b/tools/eksDistroBuildToolingOpsTools/cmd/eksGoRelease/README.md
index 4dbeef8cf..043727ef6 100644
--- a/tools/eksDistroBuildToolingOpsTools/cmd/eksGoRelease/README.md
+++ b/tools/eksDistroBuildToolingOpsTools/cmd/eksGoRelease/README.md
@@ -3,27 +3,59 @@ The EKS Go Release Tool is intended as a home for all automation used to release
 It is intended to eventually replace eksGoTool.
 
 ### Using the Tool
-use `eksGoRelease --help` for up-to-date usage
+`make build-eksGoRelease` generates the binary
+`eksGoRelease --help` for up-to-date usage
+```
+Tools for updating and releasing EKS Go
+
+Usage:
+  eksGoRelease [command]
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  new         Release a new minor version of EKS Go
+  patch       Cherrypick a patch to versions of EKS Go
+  release     Release EKS Go
+  update      Update new patch versions of EKS Go
+
+Flags:
+  -d, --dryrun                  run without creating PR
+      --eksGoReleases strings   EKS Go releases to update
+  -e, --email string            github email for git functions
+  -h, --help                    help for eksGoRelease
+  -u, --user string             github username for git functions
+  -v, --verbosity int           Set the log level verbosity
+```
+#### Commands:
+`new` Create repo structure for a new minor version of EKS Go
+
+`release` Release EKS Go version(s)
 
-The tool has an `release` command which creates new minor version release structure and files.
-The tool has an `update` command which updates upstream supported versions for new patch releases.
+`update` Update new patch version(s) of EKS Go
+
+Work In Progress:
+`patch` Cherrypick a patch to version(s) of EKS Go
 
-The `release` command accepts a EKS Go release version via the flag `eksGoRelease`. 
-For example to release a new version of eksGo `1.21.0`
-you would run the following:
 
 ```shell
-eksGoRelease release --eksGoReleases=1.21.0
+eksGoRelease new --eksGoReleases=1.21.0
 ```
 
 The `update` command accepts a comma-seperated list of EKS Go release versions via the flag `eksGoRelease`. 
 Updates are run for each given release version. For example, to run updaters for the EKS Go release `1.20.2` & `1.19.3`, 
-you would run the following:
-
 ```shell
 eksGoRelease update --eksGoReleases=1.20.2,1.19.3
 ```
 
+
+The `release` command accepts a comma-seperated list of EKS Go release versions via the flag `eksGoRelease`. 
+This command is to be run after post-submits and builds pass. This command updates the README and when merged 
+runs the prowjob triggering the sns message.
+```shell
+eksGoRelease release --eksGoReleases=1.20.2,1.19.3
+```
+
 ### Building the Tool
 To build the Consumer Updater binary, run the build make target `make build-eksGoRelease`
 from the root of the Ops Tool. This will produce a binary in `tools/eksDistroBuildToolingOpsTools/bin/$GOOS/$GOARCH/eksGoRelease`.