Provide guidance on how to use buf_breaking w/o needing buf build.
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- build-system, documentation
Research direction
Start by reading the rules_buf documentation and the issue's references to buf_breaking, buf build, and proto_descriptor_set. Add user-facing guidance for running buf_breaking without buf build in fully Bazel-based repositories, including how the descriptor input fits the workflow; done means a user can follow the documented path without connecting these concepts themselves.
Written by the indexing model from the issue text.
Description
For fully bazel repositories, buf build may not be possible to use for some variety of reasons (in our case, we're using a many repo setup and have to account for complexities like bazel-generated files, we do not want to publish packages to multiple places.)
While it is easy to just use buf breaking anyway by constructing the image file using proto_descriptor_set, this is not spelled out in a user-friendly way and requires a bit of playing connect the dots ("oh a buf image is just an extended proto file descriptor, and I can build one of those through other means.")
It'd likely be helpful for other end users if this was made clearer in rules_buf's documentation.
On our end, we solved our build integration using a finalizer macro to create the lockfile image and apply linting, and have our own in-house lint to enforce the use of said finalizer macro.
- Dominant language
- Starlark
- Stars
- 63
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bufbuild/rules_buf
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 5/5 Over a week Newbie friendliness 38/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
All issues in bufbuild/rules_buf
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
sudoevolve/EUI-NEO#80 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
AppImage/appimage.github.io#9676 ·
Maintainers usually reply within 1 day
-
Flutter Improvement Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
getsentry/sentry-dart#4061 · 2 comments ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Cocoanetics/SwiftBash#95 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
ml-explore/mlx-c#136 ·