fix: clarify doc and comment with commit and push flag (#2507)

Update doc and comment around --commit and --push, these flags work for
both `generate` and `release` commands. Actual code is working as
expected.

Fixes #2495

Author: zhumin8

cmd/librarian/doc.go

@@ -118,7 +118,8 @@ Flags:
 	  	Working directory root. When this is not specified, a working directory
 	  	will be created in /tmp.
 	-push
-	  	If true, Librarian will create a commit and a pull request for the changes.
+	  	If true, Librarian will create a commit,
+	  	push and create a pull request for the changes.
 	  	A GitHub token with push access must be provided via the
 	  	LIBRARIAN_GITHUB_TOKEN environment variable.
 	-repo string
@@ -193,7 +194,7 @@ Flags:
 	  	which branch to clone and which branch to use as the base for a pull
 	  	request. (default "main")
 	-commit
-	  	If true, librarian will create a commit for the release but not create
+	  	If true, librarian will create a commit for the change but not create
 	  	a pull request. This flag is ignored if push is set to true.
 	-image string
 	  	Language specific image used to invoke code generation and releasing.
@@ -208,7 +209,8 @@ Flags:
 	  	Working directory root. When this is not specified, a working directory
 	  	will be created in /tmp.
 	-push
-	  	If true, Librarian will create a commit and a pull request for the changes.
+	  	If true, Librarian will create a commit,
+	  	push and create a pull request for the changes.
 	  	A GitHub token with push access must be provided via the
 	  	LIBRARIAN_GITHUB_TOKEN environment variable.
 	-repo string

doc/cli-commands.md

@@ -20,7 +20,8 @@ librarian generate [flags]
 | `-library`     | string  | No (Yes for onboarding) | The ID of a single library to update or onboard.  If updating this should match the library ID in the state.yaml file. |
 | `-repo`        | string  | No       | Code repository for the generated code. Can be a remote URL (e.g., `https://github.com/{owner}/{repo}`) or a local path. If not specified, will try to detect the current working directory as a language repository. |
 | `-output`      | string  | No       | Working directory root. If not specified, a working directory will be created in `/tmp`. |
-| `-push`        | bool    | No       | Whether to push the generated code and create a pull request. |
+| `-commit`      | bool    | No       | Whether to commit the generated code change locally. |
+| `-push`        | bool    | No       | Whether to push the change and create a pull request in GitHub. |
 
 ## Example
 

internal/librarian/flags.go

@@ -41,7 +41,7 @@ language-specific container.`)
 
 func addFlagCommit(fs *flag.FlagSet, cfg *config.Config) {
 	fs.BoolVar(&cfg.Commit, "commit", false,
-		`If true, librarian will create a commit for the release but not create
+		`If true, librarian will create a commit for the change but not create
 a pull request. This flag is ignored if push is set to true.`)
 }
 
@@ -87,7 +87,8 @@ If not specified, will search for all merged pull requests with the label
 
 func addFlagPush(fs *flag.FlagSet, cfg *config.Config) {
 	fs.BoolVar(&cfg.Push, "push", false,
-		fmt.Sprintf(`If true, Librarian will create a commit and a pull request for the changes.
+		fmt.Sprintf(`If true, Librarian will create a commit, 
+push and create a pull request for the changes.
 A GitHub token with push access must be provided via the
 %s environment variable.`, config.LibrarianGithubToken))
 }