From 7cc7d86971ee6cd85a4a76b3f22314d0b5992c66 Mon Sep 17 00:00:00 2001 From: Christopher Batey Date: Wed, 24 Jul 2019 10:25:53 +0100 Subject: [PATCH] Instructions for generating protobuf (#27402) * Instructions for generating protobuf * Update CONTRIBUTING.md Co-Authored-By: Arnout Engelen --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1271fc8f2..c6bc913738 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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