feat(dart): Include a correct URL for issues (#2570)

Fixes the generation side of
googleapis/google-cloud-dart#8

Author: brianquinlan

internal/sidekick/internal/dart/annotate.go

@@ -56,6 +56,7 @@ type modelAnnotations struct {
 	RepositoryURL              string
 	ReadMeAfterTitleText       string
 	ReadMeQuickstartText       string
+	IssueTrackerURL            string
 	ApiKeyEnvironmentVariables []string
 }
 
@@ -227,6 +228,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		repositoryURL              string
 		readMeAfterTitleText       string
 		readMeQuickstartText       string
+		issueTrackerURL            string
 		apiKeyEnvironmentVariables = []string{}
 	)
 
@@ -244,6 +246,10 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 			packageNameOverride = definition
 		case key == "copyright-year":
 			generationYear = definition
+		case key == "issue-tracker-url":
+			// issue-tracker-url = "http://www.example.com/issues"
+			// A link to the issue tracker for the service.
+			issueTrackerURL = definition
 		case key == "version":
 			packageVersion = definition
 		case key == "part-file":
@@ -337,6 +343,10 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		return errors.New("all packages that define a service must define 'api-keys-environment-variables'")
 	}
 
+	if issueTrackerURL == "" {
+		return errors.New("all packages must define 'issue-tracker-url'")
+	}
+
 	ann := &modelAnnotations{
 		Parent:         model,
 		PackageName:    packageName(model, packageNameOverride),
@@ -359,6 +369,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		DevDependencies:            devDependencies,
 		DoNotPublish:               doNotPublish,
 		RepositoryURL:              repositoryURL,
+		IssueTrackerURL:            issueTrackerURL,
 		ReadMeAfterTitleText:       readMeAfterTitleText,
 		ReadMeQuickstartText:       readMeQuickstartText,
 		ApiKeyEnvironmentVariables: apiKeyEnvironmentVariables,

internal/sidekick/internal/dart/annotate_test.go

@@ -26,6 +26,7 @@ import (
 var (
 	requiredConfig = map[string]string{
 		"api-keys-environment-variables": "GOOGLE_API_KEY,GEMINI_API_KEY",
+		"issue-tracker-url":              "http://www.example.com/issues",
 		"package:googleapis_auth":        "^2.0.0",
 		"package:google_cloud_gax":       "^1.2.3",
 		"package:http":                   "^4.5.6"}
@@ -34,8 +35,12 @@ var (
 func TestAnnotateModel(t *testing.T) {
 	model := api.NewTestAPI([]*api.Message{}, []*api.Enum{}, []*api.Service{})
 	model.PackageName = "test"
+
+	options := maps.Clone(requiredConfig)
+	maps.Copy(options, map[string]string{"package:google_cloud_gax": "^1.2.3"})
+
 	annotate := newAnnotateModel(model)
-	err := annotate.annotateModel(map[string]string{"package:google_cloud_gax": "^1.2.3"})
+	err := annotate.annotateModel(options)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -120,6 +125,15 @@ func TestAnnotateModel_Options(t *testing.T) {
 				}
 			},
 		},
+		{
+			map[string]string{"issue-tracker-url": "http://example.com/issues"},
+			func(t *testing.T, am *annotateModel) {
+				codec := model.Codec.(*modelAnnotations)
+				if diff := cmp.Diff("http://example.com/issues", codec.IssueTrackerURL); diff != "" {
+					t.Errorf("mismatch in Codec.IssueTrackerURL (-want, +got)\n:%s", diff)
+				}
+			},
+		},
 		{
 			map[string]string{"google_cloud_gax": "^1.2.3", "package:http": "1.2.0"},
 			func(t *testing.T, am *annotateModel) {
@@ -146,6 +160,40 @@ func TestAnnotateModel_Options(t *testing.T) {
 	}
 }
 
+func TestAnnotateModel_Options_MissingRequired(t *testing.T) {
+	method := sample.MethodListSecretVersions()
+	service := &api.Service{
+		Name:          sample.ServiceName,
+		Documentation: sample.APIDescription,
+		DefaultHost:   sample.DefaultHost,
+		Methods:       []*api.Method{method},
+		Package:       sample.Package,
+	}
+	model := api.NewTestAPI(
+		[]*api.Message{sample.ListSecretVersionsRequest(), sample.ListSecretVersionsResponse(),
+			sample.Secret(), sample.SecretVersion(), sample.Replication(), sample.Automatic(),
+			sample.CustomerManagedEncryption()},
+		[]*api.Enum{sample.EnumState()},
+		[]*api.Service{service},
+	)
+
+	var tests = []string{
+		"api-keys-environment-variables",
+		"issue-tracker-url",
+	}
+
+	for _, tt := range tests {
+		annotate := newAnnotateModel(model)
+		options := maps.Clone(requiredConfig)
+		delete(options, tt)
+
+		err := annotate.annotateModel(options)
+		if err == nil {
+			t.Fatalf("expected error when missing %q", tt)
+		}
+	}
+}
+
 func TestAnnotateMethod(t *testing.T) {
 	method := sample.MethodListSecretVersions()
 	service := &api.Service{

internal/sidekick/internal/dart/generate_test.go

@@ -16,6 +16,7 @@ package dart
 
 import (
 	"io/fs"
+	"maps"
 	"os"
 	"os/exec"
 	"path"
@@ -47,6 +48,7 @@ func TestFromProtobuf(t *testing.T) {
 		},
 		Codec: map[string]string{
 			"api-keys-environment-variables": "GOOGLE_API_KEY,GEMINI_API_KEY",
+			"issue-tracker-url":              "http://www.example.com/issues",
 			"copyright-year":                 "2025",
 			"not-for-publication":            "true",
 			"version":                        "0.1.0",
@@ -82,7 +84,11 @@ func TestFromProtobuf(t *testing.T) {
 func TestGeneratedFiles(t *testing.T) {
 	model := api.NewTestAPI([]*api.Message{}, []*api.Enum{}, []*api.Service{})
 	annotate := newAnnotateModel(model)
-	annotate.annotateModel(map[string]string{"package:google_cloud_gax": "^1.2.3", "package:http": "^4.5.6"})
+
+	options := maps.Clone(requiredConfig)
+	maps.Copy(options, map[string]string{"package:google_cloud_gax": "^1.2.3", "package:http": "^4.5.6"})
+
+	annotate.annotateModel(options)
 	files := generatedFiles(model)
 	if len(files) == 0 {
 		t.Errorf("expected a non-empty list of template files from generatedFiles()")

internal/sidekick/internal/dart/templates/README.md.mustache

@@ -35,7 +35,7 @@ The Google Cloud client library for the {{{Title}}}.
 >
 > Your feedback is valuable and will help us evolve this package. For general
 > feedback, suggestions, and comments, please file an issue in the
-> [bug tracker]({{Codec.RepositoryURL}}/issues).
+> [bug tracker]({{{Codec.IssueTrackerURL}}}).
 
 ## What's this?
 

internal/sidekick/internal/dart/templates/pubspec.yaml.mustache

@@ -23,6 +23,7 @@ description: The Google Cloud client library for the {{{Title}}}.
 {{#Codec.RepositoryURL}}
 repository: {{Codec.RepositoryURL}}
 {{/Codec.RepositoryURL}}
+issue_tracker: {{{Codec.IssueTrackerURL}}}
 {{^Codec.DoNotPublish}}
 version: {{Codec.PackageVersion}}
 {{/Codec.DoNotPublish}}