Google Git
Sign in
flutter / third_party / protobuf / d59a9e130e907f6acea1b9d78fc120e99e654b56
commitd59a9e130e907f6acea1b9d78fc120e99e654b56[log] [tgz]
authorSandy Zhang <sandyzhang@google.com>Wed Nov 27 14:45:41 2024 -0800
committerCopybara-Service <copybara-worker@google.com>Wed Nov 27 14:51:01 2024 -0800
tree0264ef134b1689c3497917c07ff136b6336c134c
parent37cc68f16a3294a5255abb290d385911ec63a9f7 [diff]
Add protobuf_extra_deps.bzl for loading dependencies necessary for external repositories in protobuf_deps.bzl.

This is needed for `rules_java` which requires additional loads for Bazel 8. This provides a single entrypoint for extra dependencies so we can add these moving forward without breaking users, and is similar to https://github.com/grpc/grpc/blob/master/bazel/grpc_extra_deps.bzl.

Non-bzlmod users should make sure to set the following in their WORKSPACE file:
```
http_archive(
    name = "protobuf",
    strip_prefix = "protobuf-VERSION",
    sha256 = ...,
    url = ...,
)

load("@protobuf//:protobuf_deps.bzl", "protobuf_deps")

protobuf_deps()

load("@protobuf//:protobuf_extra_deps.bzl", "protobuf_extra_deps")

protobuf_extra_deps();
```

PiperOrigin-RevId: 700810708
5 files changed
tree: 0264ef134b1689c3497917c07ff136b6336c134c
  1. .bcr/
  2. .github/
  3. bazel/
  4. benchmarks/
  5. build_defs/
  6. ci/
  7. cmake/
  8. compatibility/
  9. conformance/
  10. csharp/
  11. docs/
  12. editions/
  13. editors/
  14. examples/
  15. go/
  16. hpb/
  17. hpb_generator/
  18. java/
  19. lua/
  20. objectivec/
  21. php/
  22. pkg/
  23. python/
  24. ruby/
  25. rust/
  26. src/
  27. third_party/
  28. toolchain/
  29. upb/
  30. upb_generator/
  31. .bazelignore
  32. .bazelrc
  33. .clang-format
  34. .gitignore
  35. .gitmodules
  36. .readthedocs.yml
  37. appveyor.bat
  38. appveyor.yml
  39. BUILD.bazel
  40. Cargo.bazel.lock
  41. Cargo.lock
  42. CMakeLists.txt
  43. CODE_OF_CONDUCT.md
  44. CONTRIBUTING.md
  45. CONTRIBUTORS.txt
  46. fix_permissions.sh
  47. generate_descriptor_proto.sh
  48. global.json
  49. google3_export_generated_files.sh
  50. LICENSE
  51. maven_install.json
  52. MODULE.bazel
  53. PrivacyInfo.xcprivacy
  54. protobuf.bzl
  55. Protobuf.podspec
  56. protobuf_deps.bzl
  57. protobuf_extra_deps.bzl
  58. protobuf_release.bzl
  59. protobuf_version.bzl
  60. README.md
  61. regenerate_stale_files.sh
  62. SECURITY.md
  63. version.json
  64. WORKSPACE
  65. WORKSPACE.bzlmod
README.md

Protocol Buffers - Google's data interchange format

OpenSSF Scorecard

Copyright 2023 Google LLC

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can learn more about it in protobuf's documentation.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Working With Protobuf Source Code

Most users will find working from supported releases to be the easiest path.

If you choose to work from the head revision of the main branch your build will occasionally be broken by source-incompatible changes and insufficiently-tested (and therefore broken) behavior.

If you are using C++ or otherwise need to build protobuf from source as a part of your project, you should pin to a release commit on a release branch.

This is because even release branches can experience some instability in between release commits.

Bazel with Bzlmod

Protobuf supports Bzlmod with Bazel 7 +. Users should specify a dependency on protobuf in their MODULE.bazel file as follows.

bazel_dep(name = "protobuf", version = <VERSION>)

Users can optionally override the repo name, such as for compatibility with WORKSPACE.

bazel_dep(name = "protobuf", version = <VERSION>, repo_name = "com_google_protobuf")

Bazel with WORKSPACE

Users can also add the following to their legacy WORKSPACE file.

Note that the protobuf_extra_deps.bzl is added in the v30.x release.

http_archive(
    name = "com_google_protobuf",
    strip_prefix = "protobuf-VERSION",
    sha256 = ...,
    url = ...,
)

load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")

protobuf_deps()

load("@com_google_protobuf//:protobuf_extra_deps.bzl", "protobuf_extra_deps")

protobuf_extra_deps();

Protobuf Compiler Installation

The protobuf compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our GitHub release page.

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the Maven repository.

These pre-built binaries are only provided for released versions. If you want to use the github main version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

LanguageSource
C++ (include C++ runtime and protoc)src
Javajava
Pythonpython
Objective-Cobjectivec
C#csharp
Rubyruby
Goprotocolbuffers/protobuf-go
PHPphp
Dartdart-lang/protobuf
JavaScriptprotocolbuffers/protobuf-javascript

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide.

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation is available at the Protocol Buffers doc site.

Support Policy

Read about our version support policy to stay current on support timeframes for the language libraries.

Developer Community

To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.