raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Instructions for generating protobuf (#27402)

Browse source 
* Instructions for generating protobuf

* Update CONTRIBUTING.md

Co-Authored-By: Arnout Engelen <github@bzzt.net>
This commit is contained in:
Christopher Batey 2019-07-24 10:25:53 +01:00 • committed by GitHub
parent 6d4fbfc43d
commit 7cc7d86971
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -253,6 +253,17 @@ All wire protocol changes that may concern rolling upgrades should be documented
[Rolling Update Changelog](https://doc.akka.io/docs/akka/current/project/rolling-update.html#change-log)
(found in akka-docs/src/main/paradox/project/rolling-update.md)
## Protobuf
Akka includes a shaded version of protobuf `2.5.0` that is used for internal communication. To generate files
run `protobufGenerate`. The generated files are put in the `src/main/java` of each project and need to be commited.
The generated files are automatically transformed to use the shaded version of protobuf.
Generation depends on protoc `2.5.0` being on the path. Old versions of
protoc can be downloaded from the [protobuf release page](https://github.com/protocolbuffers/protobuf/releases) and built from
source or downloaded from [maven central](http://repo1.maven.org/maven2/com/google/protobuf/protoc/2.5.0/). See
[Protobuf.scala](https://github.com/akka/akka/blob/master/project/Protobuf.scala) for details of how to override
the settings for generation.
## Pull request requirements