Skip to content

Commit 7034e50

Browse files
authored
Add info on protobuf dependency (#34069)
1 parent 170885a commit 7034e50

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

contributor-docs/java-dependency-upgrades.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,14 @@ In the case of modifying the script or diagnose, the following commands may be u
116116
mvn help:effective-pom -f base.pom -Doutput=effective.pom && cat effective.pom | \
117117
grep -v 'dependencyManagement' > cleanup.pom && \
118118
mvn dependency:tree -f cleanup.pom
119+
120+
# Protobuf Upgrades
121+
122+
There are 2 versions of Protobuf used in Beam:
123+
124+
1) The version driven by the GCP BOM version (see previous section). This version is defined as `protobuf_version` in `BeamModulePlugin.groovy` (example [update PR](protobuf_version)).
125+
2) The version driven by the vendored grpc version. This version is defined as `protobuf_version` in `buildSrc/src/main/groovy/org/apache/beam/gradle/GrpcVendoring_<version>.groovy` (example [PR #1](https://github.com/apache/beam/pull/33553) and [PR #2](https://github.com/apache/beam/pull/33555) to update).
126+
127+
These versions should be compatible. This usually means they must be on the same major version, unless cross-version compatibility is explicitly guaranteed.
128+
129+
Other dependencies are similarly defined with imported GRPC and may have similar requirements. For more info on vendoring dependencies see https://github.com/apache/beam/blob/master/vendor/README.md

0 commit comments

Comments
 (0)