feat(config): define LIBRARIAN_GITHUB_TOKEN as a constant (#2367)

jinseopkim0 · web-flow · commit 5979bfdcf661 · 2025-09-26T10:49:45.000-04:00
This change introduces a constant for the LIBRARIAN_GITHUB_TOKEN environment variable to improve maintainability and reduce duplication. Fixes #2089.
diff --git a/cmd/librarian/doc.go b/cmd/librarian/doc.go
@@ -81,7 +81,7 @@ in '.librarian/state.yaml'.
 
 Example with build and push:
 
-	SDK_LIBRARIAN_GITHUB_TOKEN=xxx librarian generate --push --build
+	LIBRARIAN_GITHUB_TOKEN=xxx librarian generate --push --build
 
 Usage:
 
diff --git a/e2e_test.go b/e2e_test.go
@@ -102,7 +102,7 @@ func TestRunGenerate(t *testing.T) {
 			}
 
 			cmd := exec.Command("go", cmdArgs...)
-			cmd.Env = append(os.Environ(), "LIBRARIAN_GITHUB_TOKEN=fake-token")
+			cmd.Env = append(os.Environ(), fmt.Sprintf("%s=fake-token", config.LibrarianGithubToken))
 			cmd.Env = append(cmd.Env, "LIBRARIAN_GITHUB_BASE_URL="+server.URL)
 			cmd.Stderr = os.Stderr
 			cmd.Stdout = os.Stdout
@@ -540,7 +540,7 @@ func TestReleaseInit(t *testing.T) {
 
 			cmd := exec.Command("go", cmdArgs...)
 			cmd.Env = os.Environ()
-			cmd.Env = append(cmd.Env, "LIBRARIAN_GITHUB_TOKEN=fake-token")
+			cmd.Env = append(cmd.Env, fmt.Sprintf("%s=fake-token", config.LibrarianGithubToken))
 			cmd.Env = append(cmd.Env, "LIBRARIAN_GITHUB_BASE_URL="+server.URL)
 			cmd.Stderr = os.Stderr
 			cmd.Stdout = os.Stdout
@@ -741,7 +741,7 @@ libraries:
 			}
 
 			cmd := exec.Command("go", cmdArgs...)
-			cmd.Env = append(os.Environ(), "LIBRARIAN_GITHUB_TOKEN=fake-token")
+			cmd.Env = append(os.Environ(), fmt.Sprintf("%s=fake-token", config.LibrarianGithubToken))
 			cmd.Stderr = os.Stderr
 			cmd.Stdout = os.Stdout
 			if err := cmd.Run(); err != nil {
diff --git a/internal/automation/trigger.go b/internal/automation/trigger.go
@@ -27,6 +27,7 @@ import (
 	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
 	"cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb"
 	"github.com/googleapis/gax-go/v2"
+	"github.com/googleapis/librarian/internal/config"
 	"github.com/googleapis/librarian/internal/github"
 )
 
@@ -73,7 +74,7 @@ func RunCommand(ctx context.Context, command string, projectId string, push bool
 	wrappedClient := &wrappedCloudBuildClient{
 		client: c,
 	}
-	ghClient := github.NewClient(os.Getenv("LIBRARIAN_GITHUB_TOKEN"), nil)
+	ghClient := github.NewClient(os.Getenv(config.LibrarianGithubToken), nil)
 	return runCommandWithClient(ctx, wrappedClient, ghClient, command, projectId, push, build, forceRun, time.Now())
 }
 
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -55,6 +55,8 @@ const (
 	ReleaseInitResponse = "release-init-response.json"
 	// LibrarianStateFile is the name of the pipeline state file.
 	LibrarianStateFile = "state.yaml"
+	// LibrarianGithubToken is the name of the env var used to store the github token.
+	LibrarianGithubToken = "LIBRARIAN_GITHUB_TOKEN"
 )
 
 // are variables so it can be replaced during testing.
@@ -248,7 +250,7 @@ type Config struct {
 func New(cmdName string) *Config {
 	return &Config{
 		CommandName: cmdName,
-		GitHubToken: os.Getenv("LIBRARIAN_GITHUB_TOKEN"),
+		GitHubToken: os.Getenv(LibrarianGithubToken),
 	}
 }
 
diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -26,7 +26,7 @@ import (
 )
 
 func TestNew(t *testing.T) {
-	t.Setenv("LIBRARIAN_GITHUB_TOKEN", "")
+	t.Setenv(LibrarianGithubToken, "")
 	for _, test := range []struct {
 		name    string
 		envVars map[string]string
@@ -35,7 +35,7 @@ func TestNew(t *testing.T) {
 		{
 			name: "All environment variables set",
 			envVars: map[string]string{
-				"LIBRARIAN_GITHUB_TOKEN":    "gh_token",
+				LibrarianGithubToken:        "gh_token",
 				"LIBRARIAN_SYNC_AUTH_TOKEN": "sync_token",
 			},
 			want: Config{
@@ -54,7 +54,7 @@ func TestNew(t *testing.T) {
 		{
 			name: "Some environment variables set",
 			envVars: map[string]string{
-				"LIBRARIAN_GITHUB_TOKEN": "gh_token",
+				LibrarianGithubToken: "gh_token",
 			},
 			want: Config{
 				GitHubToken: "gh_token",
diff --git a/internal/librarian/flags.go b/internal/librarian/flags.go
@@ -16,6 +16,7 @@ package librarian
 
 import (
 	"flag"
+	"fmt"
 
 	"github.com/googleapis/librarian/internal/config"
 )
@@ -86,9 +87,9 @@ If not specified, will search for all merged pull requests with the label
 
 func addFlagPush(fs *flag.FlagSet, cfg *config.Config) {
 	fs.BoolVar(&cfg.Push, "push", false,
-		`If true, Librarian will create a commit and a pull request for the changes.
+		fmt.Sprintf(`If true, Librarian will create a commit and a pull request for the changes.
 A GitHub token with push access must be provided via the
-LIBRARIAN_GITHUB_TOKEN environment variable.`)
+%s environment variable.`, config.LibrarianGithubToken))
 }
 
 func addFlagRepo(fs *flag.FlagSet, cfg *config.Config) {
diff --git a/internal/librarian/help.go b/internal/librarian/help.go
@@ -71,7 +71,7 @@ in '.librarian/state.yaml'.
   your local working directory for inspection.
 
 Example with build and push:
-  SDK_LIBRARIAN_GITHUB_TOKEN=xxx librarian generate --push --build`
+  LIBRARIAN_GITHUB_TOKEN=xxx librarian generate --push --build`
 
 	releaseInitLongHelp = `The 'release init' command is the primary entry point for initiating
 a new release. It automates the creation of a release pull request by parsing
diff --git a/internal/librarian/tag_and_release.go b/internal/librarian/tag_and_release.go
@@ -51,7 +51,7 @@ type tagAndReleaseRunner struct {
 
 func newTagAndReleaseRunner(cfg *config.Config) (*tagAndReleaseRunner, error) {
 	if cfg.GitHubToken == "" {
-		return nil, fmt.Errorf("`LIBRARIAN_GITHUB_TOKEN` must be set")
+		return nil, fmt.Errorf("`%s` must be set", config.LibrarianGithubToken)
 	}
 	repo, err := parseRemote(cfg.Repo)
 	if err != nil {

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ import (`
`27`	`27`	`cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"`
`28`	`28`	`"cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb"`
`29`	`29`	`"github.com/googleapis/gax-go/v2"`
	`30`	`+ "github.com/googleapis/librarian/internal/config"`
`30`	`31`	`"github.com/googleapis/librarian/internal/github"`
`31`	`32`	`)`
`32`	`33`
`@@ -73,7 +74,7 @@ func RunCommand(ctx context.Context, command string, projectId string, push bool`
`73`	`74`	`wrappedClient := &wrappedCloudBuildClient{`
`74`	`75`	`client: c,`
`75`	`76`	`}`
`76`		`- ghClient := github.NewClient(os.Getenv("LIBRARIAN_GITHUB_TOKEN"), nil)`
	`77`	`+ ghClient := github.NewClient(os.Getenv(config.LibrarianGithubToken), nil)`
`77`	`78`	`return runCommandWithClient(ctx, wrappedClient, ghClient, command, projectId, push, build, forceRun, time.Now())`
`78`	`79`	`}`
`79`	`80`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,8 @@ const (`
`55`	`55`	`ReleaseInitResponse = "release-init-response.json"`
`56`	`56`	`// LibrarianStateFile is the name of the pipeline state file.`
`57`	`57`	`LibrarianStateFile = "state.yaml"`
	`58`	`+ // LibrarianGithubToken is the name of the env var used to store the github token.`
	`59`	`+ LibrarianGithubToken = "LIBRARIAN_GITHUB_TOKEN"`
`58`	`60`	`)`
`59`	`61`
`60`	`62`	`// are variables so it can be replaced during testing.`
`@@ -248,7 +250,7 @@ type Config struct {`
`248`	`250`	`func New(cmdName string) *Config {`
`249`	`251`	`return &Config{`
`250`	`252`	`CommandName: cmdName,`
`251`		`- GitHubToken: os.Getenv("LIBRARIAN_GITHUB_TOKEN"),`
	`253`	`+ GitHubToken: os.Getenv(LibrarianGithubToken),`
`252`	`254`	`}`
`253`	`255`	`}`
`254`	`256`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ type tagAndReleaseRunner struct {`
`51`	`51`
`52`	`52`	`func newTagAndReleaseRunner(cfg config.Config) (tagAndReleaseRunner, error) {`
`53`	`53`	`if cfg.GitHubToken == "" {`
`54`		- return nil, fmt.Errorf("`LIBRARIAN_GITHUB_TOKEN` must be set")
	`54`	+ return nil, fmt.Errorf("`%s` must be set", config.LibrarianGithubToken)
`55`	`55`	`}`
`56`	`56`	`repo, err := parseRemote(cfg.Repo)`
`57`	`57`	`if err != nil {`