Skip to content

Commit 6569e90

Browse files
committed
chore: README.md section for scala_proto_toolchain changes
1 parent 97203f9 commit 6569e90

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -819,6 +819,35 @@ under WORKSPACE](#6.5.0), with the maximum dependency versions specified in
819819
that section. While this may continue to work for some time, it is not
820820
officially supported.
821821

822+
### `scala_proto_toolchain` changes
823+
824+
Since #1718 `scala_proto_toolchain`'s `main_generator` was removed in flavor of more
825+
flexible protobuf plugins configuration. Now each generator (plugin) will get a corresponding name
826+
that can be used for further plugin options setup:
827+
828+
```
829+
scala_proto_toolchain(
830+
name = "example",
831+
generators_opts = {
832+
"scala": [
833+
"grpc",
834+
"single_line_to_proto_string",
835+
],
836+
"jvm_extra_protobuf_generator": [
837+
"grpc",
838+
"single_line_to_proto_string",
839+
],
840+
},
841+
generators = {
842+
"scala": "scripts.ScalaPbCodeGenerator",
843+
"jvm_extra_protobuf_generator": "scalarules.test.extra_protobuf_generator.ExtraProtobufGenerator",
844+
},
845+
)
846+
```
847+
848+
Also, `scalapb_grpc_deps` was removed since this changes moves the responsibility
849+
on the user side to configure dependencies based on the provided generators and their options.
850+
822851
### Removal of `bind()` aliases for `twitter_scrooge` dependencies
823852

824853
`rules_scala` 7.x removes all of the obsolete [`bind()`][] aliases under

0 commit comments

Comments
 (0)