Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add curated plugin doc and collection fields #3363

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Add curated plugin doc and collection fields #3363

merged 2 commits into from
Oct 2, 2024

Conversation

mfridman
Copy link
Member

@mfridman mfridman commented Oct 2, 2024

No description provided.

@mfridman mfridman requested a review from bufdev as a code owner October 2, 2024 14:30
Copy link
Contributor

github-actions bot commented Oct 2, 2024

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedOct 2, 2024, 3:33 PM

@@ -112,6 +112,21 @@ enum DotnetTargetFramework {
DOTNET_TARGET_FRAMEWORK_NET_8_0 = 13;
}

// The collection a Plugin belongs to. These collections help organize plugins based on their
// functionality or ecosystem.
enum PluginCollection {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels like a completely new entity, not an enum - it should probably be dynamic

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, updated. I could see us expanding this to include a description, maybe a logo, create_time, etc.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't appear to be an entity - it has no ID as an example.

How does this fit into the new API, why is this going here, etc? Need more details.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a hard-coded list of plugin mappings to collections. These aren't intended to be user-configurable and there's no mechanism for users to edit these collections (at least for now).

The goal is to display older protoc plugins in the UI under these collections.

This is something we should put more careful thought into when designing the newer plugin.v1 API in registry-proto, but to unblock certain UI work feels fine to piggyback on the existing primitives?

Copy link
Member

@bufdev bufdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving to unblock, but this shape won't be approved in the API that we will be using in v1

@mfridman mfridman merged commit ffd72cd into main Oct 2, 2024
11 checks passed
@mfridman mfridman deleted the mf/plugins-rpc branch October 2, 2024 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants