Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Commit ee5eb32

Browse files
authored
fix/sg: doc usage of sg release commands (#61157)
1 parent bab523a commit ee5eb32

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

dev/sg/internal/release/release.go

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ var releaseRunFlags = []cli.Flag{
3131
Usage: "Preview all the commands that would be performed",
3232
},
3333
&cli.StringFlag{
34-
Name: "version",
35-
Value: "v6.6.666",
36-
Usage: "Force version",
34+
Name: "version",
35+
Usage: "Force version",
36+
Required: true,
3737
},
3838
&cli.StringFlag{
3939
Name: "inputs",
@@ -81,11 +81,11 @@ var Command = &cli.Command{
8181
},
8282
{
8383
Name: "internal",
84-
Usage: "todo",
84+
Usage: "Run manifest defined steps (internal releases)",
8585
Subcommands: []*cli.Command{
8686
{
8787
Name: "finalize",
88-
Usage: "Run internal release finalize steps",
88+
Usage: "Run manifest defined finalize step for internal releases",
8989
Flags: releaseRunFlags,
9090
Action: func(cctx *cli.Context) error {
9191
r, err := newReleaseRunnerFromCliContext(cctx)
@@ -99,11 +99,11 @@ var Command = &cli.Command{
9999
},
100100
{
101101
Name: "promote-to-public",
102-
Usage: "TODO",
102+
Usage: "Run manifest defined steps (public releases)",
103103
Subcommands: []*cli.Command{
104104
{
105105
Name: "finalize",
106-
Usage: "Run internal release finalize steps",
106+
Usage: "Run manifest defined finalize step for public releases",
107107
Flags: releaseRunFlags,
108108
Action: func(cctx *cli.Context) error {
109109
r, err := newReleaseRunnerFromCliContext(cctx)
@@ -118,11 +118,12 @@ var Command = &cli.Command{
118118
},
119119
},
120120
{
121-
Name: "create",
122-
Usage: "Create a release for a given product",
123-
UsageText: "sg release create --workdir [path] --type patch",
124-
Category: category.Util,
125-
Flags: releaseRunFlags,
121+
Name: "create",
122+
Usage: "Create a release for a given product",
123+
Description: "See https://go/releases",
124+
UsageText: "sg release create --workdir [path-to-folder-with-manifest] --version vX.Y.Z",
125+
Category: category.Util,
126+
Flags: releaseRunFlags,
126127
Action: func(cctx *cli.Context) error {
127128
r, err := newReleaseRunnerFromCliContext(cctx)
128129
if err != nil {
@@ -133,8 +134,8 @@ var Command = &cli.Command{
133134
},
134135
{
135136
Name: "promote-to-public",
136-
Usage: "Promete an existing release to the public",
137-
UsageText: "sg release promote-to-public --workdir [path] --type patch",
137+
Usage: "Promote an internal release to the public",
138+
UsageText: "sg release promote-to-public --workdir [path-to-folder-with-manifest] --version vX.Y.Z",
138139
Category: category.Util,
139140
Flags: releaseRunFlags,
140141
Action: func(cctx *cli.Context) error {

0 commit comments

Comments
 (0)