feat: implement commit flag for release init (#1816)

Fixes #1008

Author: JoeWang1127

internal/config/config.go

@@ -109,6 +109,12 @@ type Config struct {
 	// expected.
 	CommandName string
 
+	// Commit determines whether to creat a commit for the release but not create
+	// a pull request.
+	//
+	// This flag is ignored if Push is set to true.
+	Commit bool
+
 	// GitHubToken is the access token to use for all operations involving
 	// GitHub.
 	//

internal/librarian/command.go

@@ -227,15 +227,10 @@ func copyLibrary(dst, src string, library *config.LibraryState) error {
 // It uses the GitHub client to create a PR with the specified branch, title, and
 // description to the repository.
 func commitAndPush(ctx context.Context, cfg *config.Config, repo gitrepo.Repository, ghClient GitHubClient, commitMessage string) error {
-	if !cfg.Push {
-		slog.Info("Push flag is not specified, skipping")
+	if !cfg.Push && !cfg.Commit {
+		slog.Info("Push flag and Commit flag are not specified, skipping committing")
 		return nil
 	}
-	// Ensure we have a GitHub repository
-	gitHubRepo, err := github.FetchGitHubRepoFromRemote(repo)
-	if err != nil {
-		return err
-	}
 
 	status, err := repo.AddAll()
 	if err != nil {
@@ -263,6 +258,17 @@ func commitAndPush(ctx context.Context, cfg *config.Config, repo gitrepo.Reposit
 		return err
 	}
 
+	if !cfg.Push {
+		slog.Info("Push flag is not specified, skipping pull request creation")
+		return nil
+	}
+
+	// Ensure we have a GitHub repository
+	gitHubRepo, err := github.FetchGitHubRepoFromRemote(repo)
+	if err != nil {
+		return err
+	}
+
 	// Create a new branch, set title and message for the PR.
 	titlePrefix := "Librarian pull request"
 	title := fmt.Sprintf("%s: %s", titlePrefix, datetimeNow)

internal/librarian/command_test.go

@@ -479,16 +479,16 @@ func TestCopyOneLibrary(t *testing.T) {
 
 func TestCommitAndPush(t *testing.T) {
 	for _, test := range []struct {
-		name             string
-		setupMockRepo    func(t *testing.T) gitrepo.Repository
-		setupMockClient  func(t *testing.T) GitHubClient
-		push             bool
-		wantErr          bool
-		expectedErrMsg   string
-		validatePostTest func(t *testing.T, repo gitrepo.Repository)
+		name            string
+		setupMockRepo   func(t *testing.T) gitrepo.Repository
+		setupMockClient func(t *testing.T) GitHubClient
+		commit          bool
+		push            bool
+		wantErr         bool
+		expectedErrMsg  string
 	}{
 		{
-			name: "Push flag not specified",
+			name: "Push flag and Commit flag are not specified",
 			setupMockRepo: func(t *testing.T) gitrepo.Repository {
 				repoDir := newTestGitRepoWithCommit(t, "")
 				repo, err := gitrepo.NewRepository(&gitrepo.RepositoryOptions{Dir: repoDir})
@@ -502,14 +502,39 @@ func TestCommitAndPush(t *testing.T) {
 			},
 		},
 		{
-			name: "Happy Path",
+			name: "create a commit",
 			setupMockRepo: func(t *testing.T) gitrepo.Repository {
 				remote := git.NewRemote(memory.NewStorage(), &gogitConfig.RemoteConfig{
 					Name: "origin",
 					URLs: []string{"https://github.com/googleapis/librarian.git"},
 				})
+				status := make(git.Status)
+				status["file.txt"] = &git.FileStatus{Worktree: git.Modified}
+				return &MockRepository{
+					Dir:          t.TempDir(),
+					AddAllStatus: status,
+					RemotesValue: []*git.Remote{remote},
+				}
+			},
+			setupMockClient: func(t *testing.T) GitHubClient {
+				return &mockGitHubClient{
+					createdPR: &github.PullRequestMetadata{Number: 123, Repo: &github.Repository{Owner: "test-owner", Name: "test-repo"}},
+				}
+			},
+			commit: true,
+		},
+		{
+			name: "create a pull request",
+			setupMockRepo: func(t *testing.T) gitrepo.Repository {
+				remote := git.NewRemote(memory.NewStorage(), &gogitConfig.RemoteConfig{
+					Name: "origin",
+					URLs: []string{"https://github.com/googleapis/librarian.git"},
+				})
+				status := make(git.Status)
+				status["file.txt"] = &git.FileStatus{Worktree: git.Modified}
 				return &MockRepository{
 					Dir:          t.TempDir(),
+					AddAllStatus: status,
 					RemotesValue: []*git.Remote{remote},
 				}
 			},
@@ -523,8 +548,11 @@ func TestCommitAndPush(t *testing.T) {
 		{
 			name: "No GitHub Remote",
 			setupMockRepo: func(t *testing.T) gitrepo.Repository {
+				status := make(git.Status)
+				status["file.txt"] = &git.FileStatus{Worktree: git.Modified}
 				return &MockRepository{
 					Dir:          t.TempDir(),
+					AddAllStatus: status,
 					RemotesValue: []*git.Remote{}, // No remotes
 				}
 			},
@@ -675,7 +703,8 @@ func TestCommitAndPush(t *testing.T) {
 			repo := test.setupMockRepo(t)
 			client := test.setupMockClient(t)
 			localConfig := &config.Config{
-				Push: test.push,
+				Push:   test.push,
+				Commit: test.commit,
 			}
 
 			err := commitAndPush(context.Background(), localConfig, repo, client, "")
@@ -692,10 +721,6 @@ func TestCommitAndPush(t *testing.T) {
 				t.Errorf("%s: commitAndPush() returned unexpected error: %v", test.name, err)
 				return
 			}
-
-			if test.validatePostTest != nil {
-				test.validatePostTest(t, repo)
-			}
 		})
 	}
 }

internal/librarian/flags.go

@@ -32,6 +32,10 @@ func addFlagBuild(fs *flag.FlagSet, cfg *config.Config) {
 	fs.BoolVar(&cfg.Build, "build", false, "whether to build the generated code")
 }
 
+func addFlagCommit(fs *flag.FlagSet, cfg *config.Config) {
+	fs.BoolVar(&cfg.Commit, "commit", false, "whether to create a commit for a release")
+}
+
 func addFlagHostMount(fs *flag.FlagSet, cfg *config.Config) {
 	defaultValue := ""
 	fs.StringVar(&cfg.HostMount, "host-mount", defaultValue, "a mount point from Docker host and within the Docker. The format is {host-dir}:{local-dir}.")

internal/librarian/release_init.go

@@ -55,6 +55,7 @@ func init() {
 	fs := cmdInit.Flags
 	cfg := cmdInit.Config
 
+	addFlagCommit(fs, cfg)
 	addFlagPush(fs, cfg)
 	addFlagImage(fs, cfg)
 	addFlagLibrary(fs, cfg)

internal/librarian/release_init_test.go

@@ -22,6 +22,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/go-git/go-git/v5"
+
 	"github.com/googleapis/librarian/internal/gitrepo"
 
 	"github.com/google/go-cmp/cmp"
@@ -79,6 +81,8 @@ func TestNewInitRunner(t *testing.T) {
 
 func TestInitRun(t *testing.T) {
 	t.Parallel()
+	gitStatus := make(git.Status)
+	gitStatus["file.txt"] = &git.FileStatus{Worktree: git.Modified}
 	for _, test := range []struct {
 		name       string
 		runner     *initRunner
@@ -308,7 +312,9 @@ func TestInitRun(t *testing.T) {
 					},
 				},
 				repo: &MockRepository{
-					Dir: t.TempDir(),
+					Dir:          t.TempDir(),
+					AddAllStatus: gitStatus,
+					RemotesValue: []*git.Remote{}, // No remotes
 				},
 				librarianConfig: &config.LibrarianConfig{},
 				partialRepo:     t.TempDir(),