refactor(internal/librarian): rename release command to bump (#3644)

Rename release command to bump to avoid confusion.
Fix #3551

Author: zhumin8

internal/librarian/release.go internal/librarian/bump.gointernal/librarian/release.go renamed to internal/librarian/bump.go

@@ -56,20 +56,20 @@ var (
 	}
 )
 
-func releaseCommand() *cli.Command {
+func bumpCommand() *cli.Command {
 	return &cli.Command{
-		Name:      "release",
+		Name:      "bump",
 		Usage:     "update versions and prepare release artifacts",
-		UsageText: "librarian release [library] [--all] [--version=<version>]",
-		Description: `Release updates version numbers and prepares the files needed for a new release.
+		UsageText: "librarian bump [library] [--all] [--version=<version>]",
+		Description: `bump updates version numbers and prepares the files needed for a new release.
 
 If a library name is given, only that library is updated. The --all flag updates every
 library in the workspace. When a library is specified explicitly, the --version flag can
 be used to override the new version.
 
 Examples:
-  librarian release <library>           # update version for one library
-  librarian release --all               # update versions for all libraries`,
+  librarian bump <library>           # update version for one library
+  librarian bump --all               # update versions for all libraries`,
 		Flags: []cli.Flag{
 			&cli.BoolFlag{
 				Name:  "all",
@@ -80,11 +80,11 @@ Examples:
 				Usage: "specific version to update to; not valid with --all",
 			},
 		},
-		Action: runRelease,
+		Action: runBump,
 	}
 }
 
-func runRelease(ctx context.Context, cmd *cli.Command) error {
+func runBump(ctx context.Context, cmd *cli.Command) error {
 	all := cmd.Bool("all")
 	libraryName := cmd.Args().First()
 	versionOverride := cmd.String("version")
@@ -135,7 +135,7 @@ func runRelease(ctx context.Context, cmd *cli.Command) error {
 	}
 
 	if all {
-		if err = releaseAll(ctx, cfg, lastTag, gitExe, googleapisDir, rustSources); err != nil {
+		if err = bumpAll(ctx, cfg, lastTag, gitExe, googleapisDir, rustSources); err != nil {
 			return err
 		}
 	} else {
@@ -147,18 +147,18 @@ func runRelease(ctx context.Context, cmd *cli.Command) error {
 		if err != nil {
 			return err
 		}
-		if err = releaseLibrary(ctx, cfg, libConfg, lastTag, gitExe, versionOverride, googleapisDir, rustSources); err != nil {
+		if err = bumpLibrary(ctx, cfg, libConfg, lastTag, gitExe, versionOverride, googleapisDir, rustSources); err != nil {
 			return err
 		}
 	}
 
-	if err := postRelease(ctx, cfg); err != nil {
+	if err := postBump(ctx, cfg); err != nil {
 		return err
 	}
 	return RunTidyOnConfig(ctx, cfg)
 }
 
-func releaseAll(ctx context.Context, cfg *config.Config, lastTag, gitExe string, googleapisDir string, rustSources *rust.Sources) error {
+func bumpAll(ctx context.Context, cfg *config.Config, lastTag, gitExe string, googleapisDir string, rustSources *rust.Sources) error {
 	filesChanged, err := git.FilesChangedSince(ctx, lastTag, gitExe, cfg.Release.IgnoredChanges)
 	if err != nil {
 		return err
@@ -169,7 +169,7 @@ func releaseAll(ctx context.Context, cfg *config.Config, lastTag, gitExe string,
 			return err
 		}
 		if shouldRelease(library, filesChanged) {
-			if err := releaseLibrary(ctx, cfg, library, lastTag, gitExe, "", googleapisDir, rustSources); err != nil {
+			if err := bumpLibrary(ctx, cfg, library, lastTag, gitExe, "", googleapisDir, rustSources); err != nil {
 				return err
 			}
 		}
@@ -193,7 +193,7 @@ func shouldRelease(library *config.Library, filesChanged []string) bool {
 	return false
 }
 
-func releaseLibrary(ctx context.Context, cfg *config.Config, libConfig *config.Library, lastTag, gitExe, versionOverride, googleapisDir string, rustSources *rust.Sources) error {
+func bumpLibrary(ctx context.Context, cfg *config.Config, libConfig *config.Library, lastTag, gitExe, versionOverride, googleapisDir string, rustSources *rust.Sources) error {
 	// If the language doesn't have bespoke versioning options, a default
 	// [semver.DeriveNextOptions] instance is returned.
 	opts := languageVersioningOptions[cfg.Language]
@@ -204,7 +204,7 @@ func releaseLibrary(ctx context.Context, cfg *config.Config, libConfig *config.L
 
 	switch cfg.Language {
 	case languageFake:
-		return fakeReleaseLibrary(libConfig, nextVersion)
+		return fakeBumpLibrary(libConfig, nextVersion)
 	case languageRust:
 		release, err := rust.ManifestVersionNeedsBump(gitExe, lastTag, libConfig.Output+"/Cargo.toml")
 		if err != nil {
@@ -213,7 +213,7 @@ func releaseLibrary(ctx context.Context, cfg *config.Config, libConfig *config.L
 		if !release {
 			return nil
 		}
-		if err := rust.ReleaseLibrary(libConfig, nextVersion); err != nil {
+		if _, err := rust.Bump(libConfig, nextVersion); err != nil {
 			return err
 		}
 		if _, err := generateLibrary(ctx, cfg, libConfig.Name, googleapisDir, rustSources); err != nil {
@@ -224,12 +224,12 @@ func releaseLibrary(ctx context.Context, cfg *config.Config, libConfig *config.L
 		}
 		return nil
 	default:
-		return fmt.Errorf("language not supported for release: %q", cfg.Language)
+		return fmt.Errorf("language not supported for bump: %q", cfg.Language)
 	}
 }
 
-// postRelease performs post-release cleanup and maintenance tasks after libraries have been processed.
-func postRelease(ctx context.Context, cfg *config.Config) error {
+// postBump performs post version bump cleanup and maintenance tasks after libraries have been processed.
+func postBump(ctx context.Context, cfg *config.Config) error {
 	switch cfg.Language {
 	case languageRust:
 		cargoExe := "cargo"

internal/librarian/release_test.go internal/librarian/bump_test.gointernal/librarian/release_test.go renamed to internal/librarian/bump_test.go

@@ -38,7 +38,7 @@ import (
 // rather than an ambiguous empty string.
 const testUnusedStringParam = ""
 
-func TestReleaseCommand(t *testing.T) {
+func TestBumpCommand(t *testing.T) {
 	testhelper.RequireCommand(t, "git")
 
 	for _, test := range []struct {
@@ -51,7 +51,7 @@ func TestReleaseCommand(t *testing.T) {
 	}{
 		{
 			name:        "library name",
-			args:        []string{"librarian", "release", sample.Lib1Name},
+			args:        []string{"librarian", "bump", sample.Lib1Name},
 			cfg:         sample.Config(),
 			withChanges: []string{filepath.Join(sample.Lib1Output, "src", "lib.rs")},
 			wantCfg: func() *config.Config {
@@ -63,7 +63,7 @@ func TestReleaseCommand(t *testing.T) {
 		},
 		{
 			name:        "library name and explicit version",
-			args:        []string{"librarian", "release", sample.Lib1Name, "--version=1.2.3"},
+			args:        []string{"librarian", "bump", sample.Lib1Name, "--version=1.2.3"},
 			cfg:         sample.Config(),
 			withChanges: []string{filepath.Join(sample.Lib1Output, "src", "lib.rs")},
 			wantCfg: func() *config.Config {
@@ -75,7 +75,7 @@ func TestReleaseCommand(t *testing.T) {
 		},
 		{
 			name: "all flag all have changes",
-			args: []string{"librarian", "release", "--all"},
+			args: []string{"librarian", "bump", "--all"},
 			cfg:  sample.Config(),
 			withChanges: []string{
 				filepath.Join(sample.Lib1Output, "src", "lib.rs"),
@@ -91,7 +91,7 @@ func TestReleaseCommand(t *testing.T) {
 		},
 		{
 			name:        "all flag 1 has changes",
-			args:        []string{"librarian", "release", "--all"},
+			args:        []string{"librarian", "bump", "--all"},
 			cfg:         sample.Config(),
 			withChanges: []string{filepath.Join(sample.Lib1Output, "src", "lib.rs")},
 			wantCfg: func() *config.Config {
@@ -103,7 +103,7 @@ func TestReleaseCommand(t *testing.T) {
 		},
 		{
 			name:        "preview library released",
-			args:        []string{"librarian", "release", sample.Lib1Name},
+			args:        []string{"librarian", "bump", sample.Lib1Name},
 			withChanges: []string{filepath.Join(sample.Lib1Output, "src", "lib.rs")},
 			cfg:         sample.Config(),
 			previewCfg:  sample.PreviewConfig(),
@@ -116,7 +116,7 @@ func TestReleaseCommand(t *testing.T) {
 		},
 		{
 			name: "all preview libraries released",
-			args: []string{"librarian", "release", "--all"},
+			args: []string{"librarian", "bump", "--all"},
 			withChanges: []string{
 				filepath.Join(sample.Lib1Output, "src", "lib.rs"),
 				filepath.Join(sample.Lib2Output, "src", "lib.rs"),
@@ -177,7 +177,7 @@ func TestReleaseCommand(t *testing.T) {
 	}
 }
 
-func TestReleaseCommand_Error(t *testing.T) {
+func TestBumpCommand_Error(t *testing.T) {
 	testhelper.RequireCommand(t, "git")
 
 	for _, test := range []struct {
@@ -189,34 +189,34 @@ func TestReleaseCommand_Error(t *testing.T) {
 	}{
 		{
 			name:    "no args",
-			args:    []string{"librarian", "release"},
+			args:    []string{"librarian", "bump"},
 			wantErr: errMissingLibraryOrAllFlag,
 		},
 		{
 			name:    "library name and all flag",
-			args:    []string{"librarian", "release", "foo", "--all"},
+			args:    []string{"librarian", "bump", "foo", "--all"},
 			wantErr: errBothLibraryAndAllFlag,
 		},
 		{
 			name:    "version flag and all flag",
-			args:    []string{"librarian", "release", "--version=1.2.3", "--all"},
+			args:    []string{"librarian", "bump", "--version=1.2.3", "--all"},
 			wantErr: errBothVersionAndAllFlag,
 		},
 		{
 			name:    "missing librarian yaml file",
-			args:    []string{"librarian", "release", "--all"},
+			args:    []string{"librarian", "bump", "--all"},
 			wantErr: errNoYaml,
 		},
 		{
 			name:    "local repo is dirty",
-			args:    []string{"librarian", "release", "--all"},
+			args:    []string{"librarian", "bump", "--all"},
 			cfg:     sample.Config(),
 			dirty:   true,
 			wantErr: git.ErrGitStatusUnclean,
 		},
 		{
 			name: "release config empty",
-			args: []string{"librarian", "release", "--all"},
+			args: []string{"librarian", "bump", "--all"},
 			cfg: func() *config.Config {
 				c := sample.Config()
 
@@ -297,7 +297,7 @@ func TestLibraryByName(t *testing.T) {
 	}
 }
 
-func TestReleaseLibrary(t *testing.T) {
+func TestBumpLibrary(t *testing.T) {
 	testhelper.RequireCommand(t, "git")
 
 	tests := []struct {
@@ -359,9 +359,9 @@ func TestReleaseLibrary(t *testing.T) {
 
 			targetLibCfg := targetCfg.Libraries[0]
 			// Unused string param: lastTag.
-			err := releaseLibrary(t.Context(), targetCfg, targetLibCfg, testUnusedStringParam, "git", test.versionOverride, "", nil)
+			err := bumpLibrary(t.Context(), targetCfg, targetLibCfg, testUnusedStringParam, "git", test.versionOverride, "", nil)
 			if err != nil {
-				t.Fatalf("releaseLibrary() error = %v", err)
+				t.Fatalf("bumpLibrary() error = %v", err)
 			}
 			if targetLibCfg.Version != test.wantVersion {
 				t.Errorf("library %q version mismatch: want %q, got %q", targetLibCfg.Name, test.wantVersion, targetLibCfg.Version)
@@ -371,7 +371,7 @@ func TestReleaseLibrary(t *testing.T) {
 	}
 }
 
-func TestReleaseAll(t *testing.T) {
+func TestBumpAll(t *testing.T) {
 	testhelper.RequireCommand(t, "git")
 
 	for _, test := range []struct {
@@ -439,7 +439,7 @@ func TestReleaseAll(t *testing.T) {
 			}
 			testhelper.Setup(t, opts)
 
-			err := releaseAll(t.Context(), targetCfg, sinceTag, "git", "", nil)
+			err := bumpAll(t.Context(), targetCfg, sinceTag, "git", "", nil)
 			if err != nil {
 				t.Fatal(err)
 			}
@@ -453,7 +453,7 @@ func TestReleaseAll(t *testing.T) {
 	}
 }
 
-func TestPostRelease(t *testing.T) {
+func TestPostBump(t *testing.T) {
 	fakeCargo := filepath.Join(t.TempDir(), "fake-cargo")
 	for _, test := range []struct {
 		name    string
@@ -508,9 +508,9 @@ func TestPostRelease(t *testing.T) {
 				test.setup()
 			}
 
-			err := postRelease(t.Context(), test.cfg)
+			err := postBump(t.Context(), test.cfg)
 			if (err != nil) != test.wantErr {
-				t.Errorf("postRelease() error = %v, wantErr %v", err, test.wantErr)
+				t.Errorf("postBump() error = %v, wantErr %v", err, test.wantErr)
 			}
 		})
 	}

internal/librarian/fake.go

@@ -25,7 +25,7 @@ import (
 
 const fakePublishedFile = "PUBLISHED"
 
-func fakeReleaseLibrary(lib *config.Library, nextVersion string) error {
+func fakeBumpLibrary(lib *config.Library, nextVersion string) error {
 	lib.Version = nextVersion
 	return nil
 }

internal/librarian/librarian.go

@@ -41,7 +41,7 @@ func Run(ctx context.Context, args ...string) error {
 		Commands: []*cli.Command{
 			addCommand(),
 			generateCommand(),
-			releaseCommand(),
+			bumpCommand(),
 			tidyCommand(),
 			updateCommand(),
 			versionCommand(),

internal/librarian/rust/release.go internal/librarian/rust/bump.gointernal/librarian/rust/release.go renamed to internal/librarian/rust/bump.go

@@ -28,32 +28,33 @@ var (
 	errMissingVersion = errors.New("version must not be empty")
 )
 
-// ReleaseLibrary bumps version for Cargo.toml files and updates librarian config version.
-func ReleaseLibrary(library *config.Library, version string) error {
+// Bump bumps version for Cargo.toml files and updates librarian config version
+// for a library.
+func Bump(library *config.Library, version string) (*config.Library, error) {
 	if version == "" {
-		return errMissingVersion
+		return nil, errMissingVersion
 	}
 
 	cargoFile := filepath.Join(library.Output, "Cargo.toml")
 	_, err := os.Stat(cargoFile)
 	switch {
 	case err != nil && !os.IsNotExist(err):
-		return err
+		return nil, err
 	case os.IsNotExist(err):
 		cargo := fmt.Sprintf(`[package]
 name                   = "%s"
 version                = "%s"
 edition                = "2021"
 `, library.Name, version)
 		if err := os.WriteFile(cargoFile, []byte(cargo), 0644); err != nil {
-			return err
+			return nil, err
 		}
 	default:
 		if err := updateCargoVersion(cargoFile, version); err != nil {
-			return err
+			return nil, err
 		}
 	}
 
 	library.Version = version
-	return nil
+	return library, nil
 }