Skip to content

Add integration guide url to buf plugin config#2511

Merged
mfridman merged 4 commits intomainfrom
mf-update-plugins-config
Oct 24, 2023
Merged

Add integration guide url to buf plugin config#2511
mfridman merged 4 commits intomainfrom
mf-update-plugins-config

Conversation

@mfridman
Copy link
Member

@mfridman mfridman commented Oct 23, 2023

This PR extends the buf.plugin.yaml configuration to allow for a integration_guide_url.

This field is intended to link to an external integration guide for the plugin, e.g.,

https://buf.build/docs/bsr/remote-packages/swift#doc-content

@mfridman mfridman requested a review from bufdev as a code owner October 23, 2023 19:39
@mfridman mfridman requested a review from pkwarren October 23, 2023 19:47
// Visibility indicates whether the plugin is public or private.
CuratedPluginVisibility visibility = 17;
// The URL leading to the integration guide of the plugin, if available.
string integration_guide_url = 18;
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this also be added to CuratedPlugin message type?

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, I can add it in the same PR. I wanted to break this into 2 PR's, the config+request side, but no issue also updating the core type.

@mfridman mfridman merged commit c29e78d into main Oct 24, 2023
@mfridman mfridman deleted the mf-update-plugins-config branch October 24, 2023 14:03
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.

3 participants