add note about proto version to README.rst (#2232)

open-telemetry · Oct 21, 2021 · 67d65ba · 67d65ba
1 parent f6e793a
commit 67d65ba
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/opentelemetry-proto/README.rst b/opentelemetry-proto/README.rst
@@ -6,6 +6,11 @@ OpenTelemetry Python Proto
 .. |pypi| image:: https://badge.fury.io/py/opentelemetry-proto.svg
    :target: https://pypi.org/project/opentelemetry-proto/
 
+This library contains the generated code for OpenTelemetry protobuf data model. The code in the current
+package was generated using the v0.9.0 release_ of opentelemetry-proto.
+
+.. _release: https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.9.0
+
 Installation
 ------------
 

diff --git a/scripts/proto_codegen.sh b/scripts/proto_codegen.sh
@@ -70,3 +70,5 @@ python -m grpc_tools.protoc \
     --mypy_out=. \
     --grpc_python_out=. \
     $service_protos
+
+echo "Please update ./opentelemetry-proto/README.rst to include the updated version."