fix(librarian): add release related fields to state (#1630)

add new fields related to release according to
[go/librarian:release-command](http://goto.google.com/librarian:release-command).

Fixes #1006

Author: zhumin8

doc/state-schema.md

@@ -24,6 +24,8 @@ Each object in the `libraries` list represents a single library and has the foll
 | `source_roots`          | list   | A list of directories in the language repository where Librarian contributes code.                                                                                    | Yes      | Must not be empty, and each path must be a valid directory path. |
 | `preserve_regex`        | list   | A list of regular expressions for files and directories to preserve during the copy and remove process.                                                                    | No       | Each entry must be a valid regular expression. |
 | `remove_regex`          | list   | A list of regular expressions for files and directories to remove before copying generated code. If not set, this defaults to the `source_roots`. A more specific `preserve_regex` takes precedence. | No       | Each entry must be a valid regular expression. |
+| `release_exclude_paths` | list   | A list of directories to exclude from the release.                                                                                                                    | No       | Each entry must be a valid directory path.     |
+| `tag_format`            | string | A format string for the release tag. The supported placeholders are `{id}` and `{version}`.                                                                           | No       | Must only contain `{id}` and `{version}` as placeholders. |
 
 ## `apis` Object
 

internal/config/state.go

@@ -99,6 +99,14 @@ type LibraryState struct {
 	// If not set, this defaults to the `source_roots`.
 	// A more specific `preserve_regex` takes precedence.
 	RemoveRegex []string `yaml:"remove_regex" json:"remove_regex"`
+	// Path of commits to be excluded from parsing while calculating library changes.
+	// If all files from commit belong to one of the paths it will be skipped.
+	ReleaseExcludePaths []string `yaml:"release_exclude_paths,omitempty" json:"release_exclude_paths,omitempty"`
+	// Specifying a tag format allows librarian to honor this format when creating
+	// a tag for the release of the library. The replacement values of {id} and {version}
+	// permitted to reference the values configured in the library. If not specified
+	// the assumed format is {id}-{version}.
+	TagFormat string `yaml:"tag_format,omitempty" json:"tag_format,omitempty"`
 	// An error message from the docker response.
 	// This field is ignored when writing to state.yaml.
 	ErrorMessage string `yaml:"-" json:"error,omitempty"`
@@ -108,6 +116,7 @@ var (
 	libraryIDRegex = regexp.MustCompile(`^[a-zA-Z0-9/._-]+$`)
 	semverRegex    = regexp.MustCompile(`^v?\d+\.\d+\.\d+$`)
 	hexRegex       = regexp.MustCompile("^[a-fA-F0-9]+$")
+	tagFormatRegex = regexp.MustCompile(`{[^{}]*}`)
 )
 
 // Validate checks that the Library is valid.
@@ -148,6 +157,19 @@ func (l *LibraryState) Validate() error {
 			return fmt.Errorf("invalid source_path at index %d: %q", i, p)
 		}
 	}
+	for i, p := range l.ReleaseExcludePaths {
+		if !isValidDirPath(p) {
+			return fmt.Errorf("invalid release_exclude_path at index %d: %q", i, p)
+		}
+	}
+	if l.TagFormat != "" {
+		matches := tagFormatRegex.FindAllString(l.TagFormat, -1)
+		for _, match := range matches {
+			if match != "{id}" && match != "{version}" {
+				return fmt.Errorf("invalid placeholder in tag_format: %s", match)
+			}
+		}
+	}
 	for i, r := range l.PreserveRegex {
 		if _, err := regexp.Compile(r); err != nil {
 			return fmt.Errorf("invalid preserve_regex at index %d: %w", i, err)

internal/config/state_test.go

@@ -242,6 +242,44 @@ func TestLibrary_Validate(t *testing.T) {
 			},
 			wantErr: true,
 		},
+		{
+			name: "valid release_exclude_path",
+			library: &LibraryState{
+				ID:                  "a/b",
+				SourceRoots:         []string{"src/a"},
+				APIs:                []*API{{Path: "a/b/v1"}},
+				ReleaseExcludePaths: []string{"a/b", "c"},
+			},
+		},
+		{
+			name: "invalid release_exclude_path",
+			library: &LibraryState{
+				ID:                  "a/b",
+				SourceRoots:         []string{"src/a"},
+				APIs:                []*API{{Path: "a/b/v1"}},
+				ReleaseExcludePaths: []string{"/a/b"},
+			},
+			wantErr: true,
+		},
+		{
+			name: "valid tag_format",
+			library: &LibraryState{
+				ID:          "a/b",
+				SourceRoots: []string{"src/a"},
+				APIs:        []*API{{Path: "a/b/v1"}},
+				TagFormat:   "v{id}-{version}",
+			},
+		},
+		{
+			name: "invalid tag_format placeholder",
+			library: &LibraryState{
+				ID:          "a/b",
+				SourceRoots: []string{"src/a"},
+				APIs:        []*API{{Path: "a/b/v1"}},
+				TagFormat:   "{id}-{foo}",
+			},
+			wantErr: true,
+		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			if err := test.library.Validate(); (err != nil) != test.wantErr {