feat: add pr body to generate pull request (#1909)

Fixes #1703

Author: JoeWang1127

internal/github/github.go

@@ -143,7 +143,9 @@ func (c *Client) CreatePullRequest(ctx context.Context, repo *Repository, remote
 		slog.Warn("Provided PR body is empty, setting default.")
 		body = "Regenerated all changed APIs. See individual commits for details."
 	}
-	slog.Info("Creating PR", "branch", remoteBranch, "title", title, "body", body)
+	slog.Info("Creating PR", "branch", remoteBranch, "base", baseBranch, "title", title)
+	// The body may be excessively long, only display in debug mode.
+	slog.Debug("with PR body", "body", body)
 	newPR := &github.NewPullRequest{
 		Title:               &title,
 		Head:                &remoteBranch,

internal/gitrepo/gitrepo.go

@@ -174,6 +174,7 @@ func (r *LocalRepository) AddAll() (git.Status, error) {
 // Commit creates a new commit with the provided message and author
 // information.
 func (r *LocalRepository) Commit(msg string) error {
+	slog.Info("Committing", "message", msg)
 	worktree, err := r.repo.Worktree()
 	if err != nil {
 		return err
@@ -424,7 +425,7 @@ func (r *LocalRepository) CreateBranchAndCheckout(name string) error {
 func (r *LocalRepository) Push(branchName string) error {
 	// https://stackoverflow.com/a/75727620
 	refSpec := config.RefSpec(fmt.Sprintf("+refs/heads/%s:refs/heads/%s", branchName, branchName))
-	slog.Info("Pushing changes", slog.Any("refspec", refSpec))
+	slog.Info("Pushing changes", "branch name", branchName, slog.Any("refspec", refSpec))
 	var auth *httpAuth.BasicAuth
 	if r.gitPassword != "" {
 		slog.Info("Authenticating with basic auth")

internal/librarian/command.go

@@ -29,8 +29,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/googleapis/librarian/internal/conventionalcommits"
-
 	"github.com/googleapis/librarian/internal/docker"
 
 	"github.com/googleapis/librarian/internal/config"
@@ -44,13 +42,14 @@ const (
 )
 
 type commitInfo struct {
-	cfg               *config.Config
-	state             *config.LibrarianState
-	repo              gitrepo.Repository
-	ghClient          GitHubClient
-	additionalMessage string
-	commitMessage     string
-	prType            string
+	cfg             *config.Config
+	state           *config.LibrarianState
+	repo            gitrepo.Repository
+	ghClient        GitHubClient
+	idToCommits     map[string]string
+	failedLibraries []string
+	commitMessage   string
+	prType          string
 }
 
 type commandRunner struct {
@@ -251,7 +250,7 @@ func copyLibraryFiles(state *config.LibrarianState, dest, libraryID, src string)
 	for _, srcRoot := range library.SourceRoots {
 		dstPath := filepath.Join(dest, srcRoot)
 		srcPath := filepath.Join(src, srcRoot)
-		files, err := getDirectoryFilesnames(srcPath)
+		files, err := getDirectoryFilenames(srcPath)
 		if err != nil {
 			return err
 		}
@@ -267,7 +266,7 @@ func copyLibraryFiles(state *config.LibrarianState, dest, libraryID, src string)
 	return nil
 }
 
-func getDirectoryFilesnames(dir string) ([]string, error) {
+func getDirectoryFilenames(dir string) ([]string, error) {
 	if _, err := os.Stat(dir); err != nil {
 		// Skip dirs that don't exist
 		if os.IsNotExist(err) {
@@ -310,27 +309,6 @@ func copyLibrary(dst, src string, library *config.LibraryState) error {
 	return nil
 }
 
-func coerceLibraryChanges(commits []*conventionalcommits.ConventionalCommit) []*config.Change {
-	changes := make([]*config.Change, 0)
-	for _, commit := range commits {
-		clNum := ""
-		if cl, ok := commit.Footers[KeyClNum]; ok {
-			clNum = cl
-		}
-
-		changeType := getChangeType(commit)
-		changes = append(changes, &config.Change{
-			Type:       changeType,
-			Subject:    commit.Description,
-			Body:       commit.Body,
-			ClNum:      clNum,
-			CommitHash: commit.SHA,
-		})
-	}
-
-	return changes
-}
-
 // commitAndPush creates a commit and push request to GitHub for the generated
 // changes.
 // It uses the GitHub client to create a PR with the specified branch, title, and
@@ -354,15 +332,11 @@ func commitAndPush(ctx context.Context, info *commitInfo) error {
 
 	datetimeNow := formatTimestamp(time.Now())
 	branch := fmt.Sprintf("librarian-%s", datetimeNow)
-	slog.Info("Creating branch", slog.String("branch", branch))
 	if err := repo.CreateBranchAndCheckout(branch); err != nil {
 		return err
 	}
 
-	// TODO: get correct language for message (https://github.com/googleapis/librarian/issues/885)
-	commitMessage := info.commitMessage
-	slog.Info("Committing", "message", commitMessage)
-	if err := repo.Commit(commitMessage); err != nil {
+	if err := repo.Commit(info.commitMessage); err != nil {
 		return err
 	}
 
@@ -382,14 +356,29 @@ func commitAndPush(ctx context.Context, info *commitInfo) error {
 	}
 
 	title := fmt.Sprintf("Librarian %s pull request: %s", info.prType, datetimeNow)
-	slog.Info("Creating pull request", slog.String("branch", branch), slog.String("title", title))
-	if _, err = info.ghClient.CreatePullRequest(ctx, gitHubRepo, branch, cfg.Branch, title, commitMessage); err != nil {
+	prBody, err := createPRBody(info)
+	if err != nil {
+		return fmt.Errorf("failed to create pull request body: %w", err)
+	}
+
+	if _, err = info.ghClient.CreatePullRequest(ctx, gitHubRepo, branch, cfg.Branch, title, prBody); err != nil {
 		return fmt.Errorf("failed to create pull request: %w", err)
 	}
 
 	return nil
 }
 
+func createPRBody(info *commitInfo) (string, error) {
+	switch info.prType {
+	case generate:
+		return formatGenerationPRBody(info.repo, info.state, info.idToCommits, info.failedLibraries)
+	case release:
+		return formatReleaseNotes(info.repo, info.state)
+	default:
+		return "", fmt.Errorf("unrecognized pull request type: %s", info.prType)
+	}
+}
+
 func copyFile(dst, src string) (err error) {
 	sourceFile, err := os.Open(src)
 	if err != nil {

internal/librarian/command_test.go

@@ -1089,6 +1089,8 @@ func TestCommitAndPush(t *testing.T) {
 		name            string
 		setupMockRepo   func(t *testing.T) gitrepo.Repository
 		setupMockClient func(t *testing.T) GitHubClient
+		state           *config.LibrarianState
+		prType          string
 		commit          bool
 		push            bool
 		wantErr         bool
@@ -1107,6 +1109,7 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
+			prType: "generate",
 		},
 		{
 			name: "create a commit",
@@ -1128,6 +1131,7 @@ func TestCommitAndPush(t *testing.T) {
 					createdPR: &github.PullRequestMetadata{Number: 123, Repo: &github.Repository{Owner: "test-owner", Name: "test-repo"}},
 				}
 			},
+			prType: "generate",
 			commit: true,
 		},
 		{
@@ -1150,7 +1154,9 @@ func TestCommitAndPush(t *testing.T) {
 					createdPR: &github.PullRequestMetadata{Number: 123, Repo: &github.Repository{Owner: "test-owner", Name: "test-repo"}},
 				}
 			},
-			push: true,
+			state:  &config.LibrarianState{},
+			prType: "generate",
+			push:   true,
 		},
 		{
 			name: "No GitHub Remote",
@@ -1166,6 +1172,7 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
+			prType:         "generate",
 			push:           true,
 			wantErr:        true,
 			expectedErrMsg: "could not find an 'origin' remote",
@@ -1186,6 +1193,7 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
+			prType:         "generate",
 			push:           true,
 			wantErr:        true,
 			expectedErrMsg: "mock add all error",
@@ -1210,6 +1218,7 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
+			prType:         "generate",
 			push:           true,
 			wantErr:        true,
 			expectedErrMsg: "create branch error",
@@ -1234,6 +1243,7 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
+			prType:         "generate",
 			push:           true,
 			wantErr:        true,
 			expectedErrMsg: "commit error",
@@ -1258,10 +1268,36 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
+			prType:         "generate",
 			push:           true,
 			wantErr:        true,
 			expectedErrMsg: "push error",
 		},
+		{
+			name: "Create PR body error",
+			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{}
+			},
+			state:          &config.LibrarianState{},
+			prType:         "random",
+			push:           true,
+			wantErr:        true,
+			expectedErrMsg: "failed to create pull request body",
+		},
 		{
 			name: "Create pull request error",
 			setupMockRepo: func(t *testing.T) gitrepo.Repository {
@@ -1283,6 +1319,8 @@ func TestCommitAndPush(t *testing.T) {
 					createPullRequestErr: errors.New("create pull request error"),
 				}
 			},
+			state:          &config.LibrarianState{},
+			prType:         "generate",
 			push:           true,
 			wantErr:        true,
 			expectedErrMsg: "failed to create pull request",
@@ -1303,7 +1341,8 @@ func TestCommitAndPush(t *testing.T) {
 			setupMockClient: func(t *testing.T) GitHubClient {
 				return nil
 			},
-			push: true,
+			prType: "generate",
+			push:   true,
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
@@ -1315,11 +1354,11 @@ func TestCommitAndPush(t *testing.T) {
 			}
 			commitInfo := &commitInfo{
 				cfg:           localConfig,
-				state:         nil,
+				state:         test.state,
 				repo:          repo,
 				ghClient:      client,
 				commitMessage: "",
-				prType:        generate,
+				prType:        test.prType,
 			}
 			err := commitAndPush(context.Background(), commitInfo)