feat: release_blocked field in per-library configuration (#2243)

suztomo · web-flow · commit f12f284deb11 · 2025-09-19T20:12:41.000Z
Fixes #897. This change implements the "release init" command part (`release_blocked`). When library config has release_blocked field set to true, the "release init" command skips the library processing. If the library ID is explicitly specified, then `release_blocked` is ignored.
diff --git a/doc/config-schema.md b/doc/config-schema.md
@@ -29,7 +29,8 @@ Each object in the `libraries` list represents a single library and has the foll
 |-------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------|
 | `id`           | string | A unique identifier for the library, in a language-specific format. It should not be empty and only contains alphanumeric characters, slashes, periods, underscores, and hyphens. | Yes      | Must be a valid library ID.                               |
 | `next_version` | string | The next released version of the library. Ignored unless it would increase the release version.                                                                                   | No       | Must be a valid semantic version, "v" prefix is optional. |
-| `generate_blocked` | bool | Set this to `true` to skip the generation of this library. It's `false` by default. | No       |  |
+| `generate_blocked` | bool | (When this library is not explicitlly specified in the `-library` argument) Set this to `true` to skip the generation of this library. It's `false` by default. | No       |  |
+| `release_blocked`  | bool | (When this library is not explicitlly specified in the `-library` argument) Set this to `true` to skip the release of this library. It's `false` by default. | No       |  |
 
 ## Example
 
@@ -56,4 +57,5 @@ libraries:
   - id: "example-library"
     next_version: "2.3.4"
     generate_blocked: false
+    release_blocked: false
 ```
diff --git a/internal/config/librarian_config.go b/internal/config/librarian_config.go
@@ -35,6 +35,7 @@ type LibraryConfig struct {
 	LibraryID       string `yaml:"id"`
 	NextVersion     string `yaml:"next_version"`
 	GenerateBlocked bool   `yaml:"generate_blocked"`
+	ReleaseBlocked  bool   `yaml:"release_blocked"`
 }
 
 // GlobalFile defines the global files in language repositories.
diff --git a/internal/librarian/release_init.go b/internal/librarian/release_init.go
@@ -142,6 +142,14 @@ func (r *initRunner) runInitCommand(ctx context.Context, outputDir string) error
 	// Mark if there are any library that needs to be released
 	foundReleasableLibrary := false
 	for _, library := range librariesToRelease {
+		if r.librarianConfig != nil {
+			libraryConfig := r.librarianConfig.LibraryConfigFor(library.ID)
+			if libraryConfig != nil && libraryConfig.ReleaseBlocked && r.library != library.ID {
+				// Do not skip the `release_blocked` library if library ID is explicitly specified.
+				slog.Info("library has release_blocked, skipping", "id", library.ID)
+				continue
+			}
+		}
 		if err := r.processLibrary(library); err != nil {
 			return err
 		}
diff --git a/internal/librarian/release_init_test.go b/internal/librarian/release_init_test.go
@@ -295,6 +295,136 @@ func TestInitRun(t *testing.T) {
 				},
 			},
 		},
+		{
+			name:            "run release init command, skips blocked libraries!",
+			containerClient: &mockContainerClient{},
+			dockerInitCalls: 1,
+			setupRunner: func(containerClient *mockContainerClient) *initRunner {
+				return &initRunner{
+					workRoot:        t.TempDir(),
+					containerClient: containerClient,
+					state: &config.LibrarianState{
+						Libraries: []*config.LibraryState{
+							{
+								ID:      "blocked-example-id",
+								Version: "1.0.0",
+							},
+							{
+								ID:      "example-id",
+								Version: "2.0.0",
+							},
+						},
+					},
+					repo: &MockRepository{
+						Dir: t.TempDir(),
+						GetCommitsForPathsSinceTagValueByTag: map[string][]*gitrepo.Commit{
+							"blocked-example-id-1.0.0": {
+								{
+									Hash:    plumbing.NewHash("123456"),
+									Message: "feat: another new feature",
+								},
+							},
+							"example-id-2.0.0": {
+								{
+									Hash:    plumbing.NewHash("abcdefg"),
+									Message: "feat: a new feature",
+								},
+							},
+						},
+						ChangedFilesInCommitValueByHash: map[string][]string{
+							plumbing.NewHash("123456").String(): {
+								"dir1/file1.txt",
+							},
+							plumbing.NewHash("abcdefg").String(): {
+								"dir1/file2.txt",
+							},
+						},
+					},
+					librarianConfig: &config.LibrarianConfig{
+						Libraries: []*config.LibraryConfig{
+							{LibraryID: "blocked-example-id", ReleaseBlocked: true},
+							{LibraryID: "example-id"},
+						},
+					},
+					partialRepo: t.TempDir(),
+				}
+			},
+			want: &config.LibrarianState{
+				Libraries: []*config.LibraryState{
+					{
+						ID:            "blocked-example-id",
+						Version:       "1.0.0", // version is NOT bumped.
+						APIs:          []*config.API{},
+						SourceRoots:   []string{},
+						PreserveRegex: []string{},
+						RemoveRegex:   []string{},
+					},
+					{
+						ID:            "example-id",
+						Version:       "2.1.0", // version is bumped.
+						APIs:          []*config.API{},
+						SourceRoots:   []string{},
+						PreserveRegex: []string{},
+						RemoveRegex:   []string{},
+					},
+				},
+			},
+		},
+		{
+			name:            "run release init command, does not skip blocked library if explicitly specified",
+			containerClient: &mockContainerClient{},
+			dockerInitCalls: 1,
+			setupRunner: func(containerClient *mockContainerClient) *initRunner {
+				return &initRunner{
+					workRoot:        t.TempDir(),
+					containerClient: containerClient,
+					// The library is explicitly specified.
+					library: "blocked-example-id",
+					state: &config.LibrarianState{
+						Libraries: []*config.LibraryState{
+							{
+								ID:      "blocked-example-id",
+								Version: "1.0.0",
+							},
+						},
+					},
+					repo: &MockRepository{
+						Dir: t.TempDir(),
+						GetCommitsForPathsSinceTagValueByTag: map[string][]*gitrepo.Commit{
+							"blocked-example-id-1.0.0": {
+								{
+									Hash:    plumbing.NewHash("123456"),
+									Message: "feat: another new feature",
+								},
+							},
+						},
+						ChangedFilesInCommitValueByHash: map[string][]string{
+							plumbing.NewHash("123456").String(): {
+								"dir1/file1.txt",
+							},
+						},
+					},
+					librarianConfig: &config.LibrarianConfig{
+						Libraries: []*config.LibraryConfig{
+							{LibraryID: "blocked-example-id", ReleaseBlocked: true},
+						},
+					},
+					partialRepo: t.TempDir(),
+				}
+			},
+			want: &config.LibrarianState{
+				Libraries: []*config.LibraryState{
+					{
+						ID:            "blocked-example-id",
+						Version:       "1.1.0",
+						APIs:          []*config.API{},
+						SourceRoots:   []string{},
+						PreserveRegex: []string{},
+						RemoveRegex:   []string{},
+					},
+				},
+			},
+		},
 		{
 			name:            "run release init command for one invalid library (invalid library id in cfg)",
 			containerClient: &mockContainerClient{},

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ type LibraryConfig struct {`
`35`	`35`	LibraryID string `yaml:"id"`
`36`	`36`	NextVersion string `yaml:"next_version"`
`37`	`37`	GenerateBlocked bool `yaml:"generate_blocked"`
	`38`	+ ReleaseBlocked bool `yaml:"release_blocked"`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`// GlobalFile defines the global files in language repositories.`