fix(librarian): bump version while updating libraries for release (#1842)

Also refactored the function a little as it takes a pointer to data so
no need to return the data -- mutate it instead.

Fixes: #1830

Author: codyoss

internal/librarian/release_init.go

@@ -119,17 +119,15 @@ func (r *initRunner) runInitCommand(ctx context.Context, outputDir string) error
 	}
 	src := r.repo.GetDir()
 
-	for i, library := range r.state.Libraries {
+	for _, library := range r.state.Libraries {
 		if r.cfg.Library != "" {
 			if r.cfg.Library != library.ID {
 				continue
 			}
 			// Only update one library with the given library ID.
-			updatedLibrary, err := updateLibrary(r.repo, library, r.cfg.LibraryVersion)
-			if err != nil {
+			if err := updateLibrary(r.repo, library, r.cfg.LibraryVersion); err != nil {
 				return err
 			}
-			r.state.Libraries[i] = updatedLibrary
 			if err := copyLibrary(dst, src, library); err != nil {
 				return err
 			}
@@ -138,11 +136,9 @@ func (r *initRunner) runInitCommand(ctx context.Context, outputDir string) error
 		}
 
 		// Update all libraries.
-		updatedLibrary, err := updateLibrary(r.repo, library, r.cfg.LibraryVersion)
-		if err != nil {
+		if err := updateLibrary(r.repo, library, r.cfg.LibraryVersion); err != nil {
 			return err
 		}
-		r.state.Libraries[i] = updatedLibrary
 		if err := copyLibrary(dst, src, library); err != nil {
 			return err
 		}
@@ -199,25 +195,10 @@ func (r *initRunner) runInitCommand(ctx context.Context, outputDir string) error
 // 2. Override the library version if libraryVersion is not empty.
 //
 // 3. Set the library's release trigger to true.
-func updateLibrary(repo gitrepo.Repository, library *config.LibraryState, libraryVersion string) (*config.LibraryState, error) {
-	updatedLibrary, err := getChangesOf(repo, library)
-	if err != nil {
-		return nil, fmt.Errorf("failed to update library, %s: %w", library.ID, err)
-	}
-
-	if libraryVersion != "" {
-		updatedLibrary.Version = libraryVersion
-	}
-	updatedLibrary.ReleaseTriggered = true
-
-	return updatedLibrary, nil
-}
-
-// getChangesOf gets commit history of the given library.
-func getChangesOf(repo gitrepo.Repository, library *config.LibraryState) (*config.LibraryState, error) {
+func updateLibrary(repo gitrepo.Repository, library *config.LibraryState, libraryVersion string) error {
 	commits, err := GetConventionalCommitsSinceLastRelease(repo, library)
 	if err != nil {
-		return nil, fmt.Errorf("failed to fetch conventional commits for library, %s: %w", library.ID, err)
+		return fmt.Errorf("failed to fetch conventional commits for library, %s: %w", library.ID, err)
 	}
 
 	changes := make([]*config.Change, 0)
@@ -236,10 +217,19 @@ func getChangesOf(repo gitrepo.Repository, library *config.LibraryState) (*confi
 			CommitHash: commit.SHA,
 		})
 	}
+	if len(changes) == 0 {
+		// Don't update the library at all
+		return nil
+	}
 
+	nextVersion, err := NextVersion(commits, library.Version, libraryVersion)
+	if err != nil {
+		return err
+	}
 	library.Changes = changes
-
-	return library, nil
+	library.Version = nextVersion
+	library.ReleaseTriggered = true
+	return nil
 }
 
 // getChangeType gets the type of the commit, adding an escalation mark (!) if

internal/librarian/release_init_test.go

@@ -294,7 +294,7 @@ func TestInitRun(t *testing.T) {
 				partialRepo: t.TempDir(),
 			},
 			wantErr:    true,
-			wantErrMsg: "failed to update library",
+			wantErrMsg: "failed to fetch conventional commits for library",
 		},
 		{
 			name: "failed to commit and push",
@@ -481,7 +481,7 @@ func TestUpdateLibrary(t *testing.T) {
 			},
 			want: &config.LibraryState{
 				ID:      "one-id",
-				Version: "1.2.3",
+				Version: "2.0.0",
 				SourceRoots: []string{
 					"one/path",
 					"two/path",
@@ -519,12 +519,11 @@ func TestUpdateLibrary(t *testing.T) {
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			var err error
-			var updated *config.LibraryState
 			if test.repo != nil {
-				updated, err = updateLibrary(test.repo, test.library, test.libraryVersion)
+				err = updateLibrary(test.repo, test.library, test.libraryVersion)
 			} else {
 				repo := setupRepoForGetCommits(t, test.pathAndMessages, test.tags)
-				updated, err = updateLibrary(repo, test.library, test.libraryVersion)
+				err = updateLibrary(repo, test.library, test.libraryVersion)
 			}
 
 			if test.wantErr {
@@ -542,7 +541,7 @@ func TestUpdateLibrary(t *testing.T) {
 			if err != nil {
 				t.Errorf("failed to run getChangesOf(): %q", err.Error())
 			}
-			if diff := cmp.Diff(test.want, updated, cmpopts.IgnoreFields(config.Change{}, "CommitHash")); diff != "" {
+			if diff := cmp.Diff(test.want, test.library, cmpopts.IgnoreFields(config.Change{}, "CommitHash")); diff != "" {
 				t.Errorf("state mismatch (-want +got):\n%s", diff)
 			}
 		})