feat: add BSR plugin configuration and documentation#49
Open
allenday wants to merge 1 commit intodatachainlab:masterfrom
Open
feat: add BSR plugin configuration and documentation#49allenday wants to merge 1 commit intodatachainlab:masterfrom
allenday wants to merge 1 commit intodatachainlab:masterfrom
Conversation
- Add buf.plugin.yaml for Buf Schema Registry distribution - Include plugin metadata, dependencies, and runtime requirements - Add comprehensive BSR integration documentation - Provide buf.gen.yaml examples for local development - Document plugin options and configuration parameters - Respect original datachainlab project attribution
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
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.
feat: add BSR plugin configuration and documentation
Summary
Changes
BSR Plugin Configuration
buf.plugin.yamlwith complete plugin metadataDocumentation Enhancements
Modern Toolchain Support
Technical Details
Files Added:
buf.plugin.yaml- BSR plugin configuration fileFiles Modified:
README.md- Added BSR configuration documentationPlugin Metadata:
buf.build/datachainlab/protoc-gen-solidityv1.0.0Configuration Examples
Local Development buf.gen.yaml
Plugin Options Documented
gen_runtime=true- Generate runtime librariesgen_runtime=CustomRuntime.sol- Custom runtime filenamesolc_version=0.8.19- Target Solidity versionfor_linking- Enable library linking modepb_libname=Custom- Custom library name prefixTest Plan
Attribution
All references properly attribute the original datachainlab/solidity-protobuf project and maintain original licensing and source information.
Impact
Modernizes the plugin for distribution via BSR, making it easier to integrate with buf-based protobuf workflows and improving overall developer experience.