Add deprecated field to curated plugins config and upload (#3421)

bufbuild · Oct 25, 2024 · 9ec7745 · 9ec7745
1 parent 866295e
commit 9ec7745
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 2 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
@@ -345,6 +345,7 @@ func createCuratedPluginRequest(
 		LicenseUrl:           pluginConfig.LicenseURL,
 		Visibility:           visibility,
 		IntegrationGuideUrl:  pluginConfig.IntegrationGuideURL,
+		Deprecated:           pluginConfig.Deprecated,
 	}, nil
 }
 

diff --git a/private/bufpkg/bufremoteplugin/bufremotepluginconfig/bufremotepluginconfig.go b/private/bufpkg/bufremoteplugin/bufremotepluginconfig/bufremotepluginconfig.go
@@ -81,6 +81,8 @@ type Config struct {
 	// IntegrationGuideURL is an optional attribute used to specify where
 	// the plugin integration guide can be found.
 	IntegrationGuideURL string
+	// Deprecated specifies whether the plugin is deprecated.
+	Deprecated bool
 }
 
 // RegistryConfig is the configuration for the registry of a plugin.
@@ -407,6 +409,7 @@ type ExternalConfig struct {
 	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"`
+	Deprecated          bool                   `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
 }
 
 // ExternalDependency represents a dependency on another plugin.

diff --git a/private/bufpkg/bufremoteplugin/bufremotepluginconfig/bufremotepluginconfig_test.go b/private/bufpkg/bufremoteplugin/bufremotepluginconfig/bufremotepluginconfig_test.go
@@ -68,6 +68,7 @@ func TestGetConfigForBucket(t *testing.T) {
 			SPDXLicenseID:       "Apache-2.0",
 			LicenseURL:          "https://github.com/grpc/grpc-go/blob/master/LICENSE",
 			IntegrationGuideURL: "https://grpc.io/docs/languages/go/quickstart",
+			Deprecated:          true,
 		},
 		pluginConfig,
 	)
@@ -109,6 +110,7 @@ func TestParsePluginConfigGoYAML(t *testing.T) {
 			SPDXLicenseID:       "Apache-2.0",
 			LicenseURL:          "https://github.com/grpc/grpc-go/blob/master/LICENSE",
 			IntegrationGuideURL: "https://grpc.io/docs/languages/go/quickstart",
+			Deprecated:          true,
 		},
 		pluginConfig,
 	)

diff --git a/private/bufpkg/bufremoteplugin/bufremotepluginconfig/config.go b/private/bufpkg/bufremoteplugin/bufremotepluginconfig/config.go
@@ -83,6 +83,7 @@ func newConfig(externalConfig ExternalConfig, options []ConfigOption) (*Config,
 		SPDXLicenseID:       spdxLicenseID,
 		LicenseURL:          externalConfig.LicenseURL,
 		IntegrationGuideURL: externalConfig.IntegrationGuideURL,
+		Deprecated:          externalConfig.Deprecated,
 	}, nil
 }
 

diff --git a/private/bufpkg/bufremoteplugin/bufremotepluginconfig/testdata/success/go/buf.plugin.yaml b/private/bufpkg/bufremoteplugin/bufremotepluginconfig/testdata/success/go/buf.plugin.yaml
@@ -18,3 +18,4 @@ registry:
 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
+deprecated: true
diff --git a/private/gen/proto/go/buf/alpha/registry/v1alpha1/plugin_curation.pb.go b/private/gen/proto/go/buf/alpha/registry/v1alpha1/plugin_curation.pb.go
diff --git a/proto/buf/alpha/registry/v1alpha1/plugin_curation.proto b/proto/buf/alpha/registry/v1alpha1/plugin_curation.proto
@@ -502,6 +502,8 @@ message CreateCuratedPluginRequest {
   CuratedPluginVisibility visibility = 17;
   // The URL leading to the integration guide of the plugin, if available.
   string integration_guide_url = 18;
+  // The deprecation status of the plugin.
+  bool deprecated = 19;
 }
 
 message CreateCuratedPluginResponse {