Add integration guide url to buf plugin config (#2511)

bufbuild · Oct 24, 2023 · c29e78d · c29e78d
1 parent 90d79c5
commit c29e78d
Show file tree

Hide file tree

Showing 7 changed files with 345 additions and 308 deletions.
diff --git a/private/buf/cmd/buf/command/beta/registry/plugin/pluginpush/pluginpush.go b/private/buf/cmd/buf/command/beta/registry/plugin/pluginpush/pluginpush.go
@@ -355,6 +355,7 @@ func createCuratedPluginRequest(
 		SpdxLicenseId:        pluginConfig.SPDXLicenseID,
 		LicenseUrl:           pluginConfig.LicenseURL,
 		Visibility:           visibility,
+		IntegrationGuideUrl:  pluginConfig.IntegrationGuideURL,
 	}, nil
 }
 

diff --git a/private/bufpkg/bufplugin/bufpluginconfig/bufpluginconfig.go b/private/bufpkg/bufplugin/bufpluginconfig/bufpluginconfig.go
@@ -78,6 +78,9 @@ type Config struct {
 	SPDXLicenseID string
 	// LicenseURL specifies where the plugin's license can be found.
 	LicenseURL string
+	// IntegrationGuideURL is an optional attribute used to specify where
+	// the the plugin integration guide can be found.
+	IntegrationGuideURL string
 }
 
 // RegistryConfig is the configuration for the registry of a plugin.
@@ -330,16 +333,17 @@ func OptionsSliceToPluginOptions(options []string) map[string]string {
 // ExternalConfig represents the on-disk representation
 // of the plugin configuration at version v1.
 type ExternalConfig struct {
-	Version         string                 `json:"version,omitempty" yaml:"version,omitempty"`
-	Name            string                 `json:"name,omitempty" yaml:"name,omitempty"`
-	PluginVersion   string                 `json:"plugin_version,omitempty" yaml:"plugin_version,omitempty"`
-	SourceURL       string                 `json:"source_url,omitempty" yaml:"source_url,omitempty"`
-	Description     string                 `json:"description,omitempty" yaml:"description,omitempty"`
-	Deps            []ExternalDependency   `json:"deps,omitempty" yaml:"deps,omitempty"`
-	OutputLanguages []string               `json:"output_languages,omitempty" yaml:"output_languages,omitempty"`
-	Registry        ExternalRegistryConfig `json:"registry,omitempty" yaml:"registry,omitempty"`
-	SPDXLicenseID   string                 `json:"spdx_license_id,omitempty" yaml:"spdx_license_id,omitempty"`
-	LicenseURL      string                 `json:"license_url,omitempty" yaml:"license_url,omitempty"`
+	Version             string                 `json:"version,omitempty" yaml:"version,omitempty"`
+	Name                string                 `json:"name,omitempty" yaml:"name,omitempty"`
+	PluginVersion       string                 `json:"plugin_version,omitempty" yaml:"plugin_version,omitempty"`
+	SourceURL           string                 `json:"source_url,omitempty" yaml:"source_url,omitempty"`
+	Description         string                 `json:"description,omitempty" yaml:"description,omitempty"`
+	Deps                []ExternalDependency   `json:"deps,omitempty" yaml:"deps,omitempty"`
+	OutputLanguages     []string               `json:"output_languages,omitempty" yaml:"output_languages,omitempty"`
+	Registry            ExternalRegistryConfig `json:"registry,omitempty" yaml:"registry,omitempty"`
+	SPDXLicenseID       string                 `json:"spdx_license_id,omitempty" yaml:"spdx_license_id,omitempty"`
+	LicenseURL          string                 `json:"license_url,omitempty" yaml:"license_url,omitempty"`
+	IntegrationGuideURL string                 `json:"integration_guide_url,omitempty" yaml:"integration_guide_url,omitempty"`
 }
 
 // ExternalDependency represents a dependency on another plugin.

diff --git a/private/bufpkg/bufplugin/bufpluginconfig/bufpluginconfig_test.go b/private/bufpkg/bufplugin/bufpluginconfig/bufpluginconfig_test.go
@@ -65,8 +65,9 @@ func TestGetConfigForBucket(t *testing.T) {
 					"separate_package": "true",
 				},
 			},
-			SPDXLicenseID: "Apache-2.0",
-			LicenseURL:    "https://github.com/grpc/grpc-go/blob/master/LICENSE",
+			SPDXLicenseID:       "Apache-2.0",
+			LicenseURL:          "https://github.com/grpc/grpc-go/blob/master/LICENSE",
+			IntegrationGuideURL: "https://grpc.io/docs/languages/go/quickstart",
 		},
 		pluginConfig,
 	)
@@ -105,8 +106,9 @@ func TestParsePluginConfigGoYAML(t *testing.T) {
 					"separate_package": "true",
 				},
 			},
-			SPDXLicenseID: "Apache-2.0",
-			LicenseURL:    "https://github.com/grpc/grpc-go/blob/master/LICENSE",
+			SPDXLicenseID:       "Apache-2.0",
+			LicenseURL:          "https://github.com/grpc/grpc-go/blob/master/LICENSE",
+			IntegrationGuideURL: "https://grpc.io/docs/languages/go/quickstart",
 		},
 		pluginConfig,
 	)

diff --git a/private/bufpkg/bufplugin/bufpluginconfig/config.go b/private/bufpkg/bufplugin/bufpluginconfig/config.go
@@ -72,15 +72,16 @@ func newConfig(externalConfig ExternalConfig, options []ConfigOption) (*Config,
 		}
 	}
 	return &Config{
-		Name:            pluginIdentity,
-		PluginVersion:   pluginVersion,
-		Dependencies:    dependencies,
-		Registry:        registryConfig,
-		SourceURL:       externalConfig.SourceURL,
-		Description:     externalConfig.Description,
-		OutputLanguages: externalConfig.OutputLanguages,
-		SPDXLicenseID:   spdxLicenseID,
-		LicenseURL:      externalConfig.LicenseURL,
+		Name:                pluginIdentity,
+		PluginVersion:       pluginVersion,
+		Dependencies:        dependencies,
+		Registry:            registryConfig,
+		SourceURL:           externalConfig.SourceURL,
+		Description:         externalConfig.Description,
+		OutputLanguages:     externalConfig.OutputLanguages,
+		SPDXLicenseID:       spdxLicenseID,
+		LicenseURL:          externalConfig.LicenseURL,
+		IntegrationGuideURL: externalConfig.IntegrationGuideURL,
 	}, nil
 }
 

diff --git a/private/bufpkg/bufplugin/bufpluginconfig/testdata/success/go/buf.plugin.yaml b/private/bufpkg/bufplugin/bufpluginconfig/testdata/success/go/buf.plugin.yaml
@@ -17,3 +17,4 @@ registry:
     - separate_package=true
 spdx_license_id: Apache-2.0
 license_url: https://github.com/grpc/grpc-go/blob/master/LICENSE
+integration_guide_url: https://grpc.io/docs/languages/go/quickstart