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

feat: Complete buf export #17733

Merged
merged 4 commits into from
Sep 14, 2023
Merged

Conversation

clockworkgr
Copy link
Contributor

@clockworkgr clockworkgr commented Sep 13, 2023

Description

buf includes well known types (e.g. google/protobuf/any, google/protobuf/descriptor etc.) implicitly. Hence buf generate does not need references to them.

However, buf export which is supposed to export all protos AND their dependencies to a specified folder (useful if you want to run some other proto tool on the SDK protos for whatever reason) assumes the same and does NOT export such well known types.

By explicitly including the protocolbuffers/wellknowntypes dep (https://buf.build/protocolbuffers/wellknowntypes) in buf.yaml, buf export will actually export the protos for those well known types as well.

This may be an edge-case scenario but seems useful (and was to me) so I thought a PR wouldn't hurt. Up to the maintaining team to decide if worth merging


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@clockworkgr clockworkgr requested a review from a team as a code owner September 13, 2023 20:19
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

I have no preference. So if that helps why not.

@julienrbrt julienrbrt added this pull request to the merge queue Sep 14, 2023
Merged via the queue into cosmos:main with commit 4e46c2f Sep 14, 2023
45 checks passed
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