Setup buf modules and cleanup README #3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
doriable
changed the title
|
The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).
|
doriable
added
the
buf skip breaking
mcy
reviewed
Jul 15, 2025
README.md
Outdated
| ) | ||
|
|
||
| // Weather data byte slice. | ||
| var weatherDataBytes = []byte{0xa, 0x7, 0x53, 0x65, 0x61, 0x74, 0x74, 0x6c, 0x65, 0x12, 0x1d, 0xa, 0x5, 0x4b, 0x41, 0x44, 0x39, 0x33, 0x15, 0x66, 0x86, 0x22, 0x43, 0x1d, 0xcd, 0xcc, 0x34, 0x41, 0x25, 0xd7, 0xa3, 0xf0, 0x41, 0x2d, 0x33, 0x33, 0x13, 0x40, 0x30, 0x3, 0x12, 0x1d, 0xa, 0x5, 0x4b, 0x48, 0x42, 0x36, 0x30, 0x15, 0xcd, 0x8c, 0x22, 0x43, 0x1d, 0x33, 0x33, 0x5b, 0x41, 0x25, 0x52, 0xb8, 0xe0, 0x41, 0x2d, 0x33, 0x33, 0xf3, 0x3f, 0x30, 0x3} |
There was a problem hiding this comment.
Can you format this so it doesn't wrap the screen?
README.md
Outdated
| "google.golang.org/protobuf/proto" | ||
|
|
||
| weatherv1 "github.com/..." | ||
| weatherv1 "buf.build/go/hyperpb/internal/gen/example/weather/v1" |
There was a problem hiding this comment.
Can we use the expected generated SDK URL here?
README.md
Outdated
| weatherv1 "buf.build/go/hyperpb/internal/gen/example/weather/v1" | ||
| ) | ||
|
|
||
| // Weather data byte slice. |
There was a problem hiding this comment.
Can you convert this to JSON and include that in the comment?
| our binary, and parse some data with it. | ||
|
|
||
| ```go | ||
| package main |
There was a problem hiding this comment.
Can you make sure these are all synced up w/ example_test.go? Might also be good to include comments on both sides to say that they need to be in sync.
mcy
approved these changes
Jul 15, 2025
mcy
pushed a commit
that referenced
this pull request
Jul 16, 2025
This is a follow-up to #3 to use generated SDKs for examples.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does some simple clean-ups:
and adjusts the
buf.gen.*yamlfiles accordingly. It alsoconfigures the
inputskey in thebuf.gen.*yamlfiles, sothey don't need to be managed in the
Makefile.weather module to the BSR.
properly when pushed to the BSR. However, since the repo is
currently private, the logo 404's. This should be fixed when
the repo is public.
and the subsequent examples are clear function definitions.
A follow-up PR will be made to use generated SDKs for examples.
We skip
buf breakingfor this PR inbuf-actionsince this PR breaksthe workspace into new modules.