Skip to content

require dependency for api/sdk to match major version #1933

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 12, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Added `BoundedAttributes` to the API to make it available for `Link` which is defined in the
API. Marked `BoundedDict` in the SDK as deprecated as a result.
([#1915](https://github.com/open-telemetry/opentelemetry-python/pull/1915))
- Updating dependency for opentelemetry api/sdk packages to support major version instead of
pinning to specific versions.
([#1933](https://github.com/open-telemetry/opentelemetry-python/pull/1933))

## [1.3.0-0.22b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.3.0-0.22b0) - 2021-06-01

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/error_handler/error_handler_0/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ package_dir=
=src
packages=find_namespace:
install_requires =
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-sdk ~= 1.3

[options.packages.find]
where = src
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/error_handler/error_handler_1/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ package_dir=
=src
packages=find_namespace:
install_requires =
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-sdk ~= 1.3

[options.packages.find]
where = src
Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-jaeger-proto-grpc/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ packages=find_namespace:
install_requires =
grpcio >= 1.0.0, < 2.0.0
googleapis-common-protos ~= 1.52
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3

[options.packages.find]
where = src
Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-jaeger-thrift/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ package_dir=
packages=find_namespace:
install_requires =
thrift >= 0.10.0
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3

[options.packages.find]
where = src
Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-opencensus/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ packages=find_namespace:
install_requires =
grpcio >= 1.0.0, < 2.0.0
opencensus-proto >= 0.1.0, < 1.0.0
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3
protobuf >= 3.13.0

[options.packages.find]
Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-otlp-proto-grpc/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ packages=find_namespace:
install_requires =
grpcio >= 1.0.0, < 2.0.0
googleapis-common-protos ~= 1.52
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3
opentelemetry-proto == 1.4.0.dev0
backoff ~= 1.10.0

Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-zipkin-json/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ package_dir=
packages=find_namespace:
install_requires =
requests ~= 2.7
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3

[options.packages.find]
where = src
Expand Down
4 changes: 2 additions & 2 deletions exporter/opentelemetry-exporter-zipkin-proto-http/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ packages=find_namespace:
install_requires =
protobuf >= 3.12
requests ~= 2.7
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3
opentelemetry-exporter-zipkin-json == 1.4.0.dev0

[options.packages.find]
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-distro/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ packages=find_namespace:
zip_safe = False
include_package_data = True
install_requires =
opentelemetry-api == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-instrumentation == 0.23.dev0
opentelemetry-sdk == 1.4.0.dev0

Expand Down
2 changes: 1 addition & 1 deletion propagator/opentelemetry-propagator-b3/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ package_dir=
=src
packages=find_namespace:
install_requires =
opentelemetry-api == 1.4.0.dev0
opentelemetry-api ~= 1.3
deprecated >= 1.2.6

[options.extras_require]
Expand Down
2 changes: 1 addition & 1 deletion propagator/opentelemetry-propagator-jaeger/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ package_dir=
=src
packages=find_namespace:
install_requires =
opentelemetry-api == 1.4.0.dev0
opentelemetry-api ~= 1.3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change only for packages upon release? Packages in development will still pin exact versions right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plan is to unpin packages in development as well. If a dev package needs a new version of the api, then the dependency will need to be updated for that package at that time.


[options.extras_require]
test =
Expand Down
50 changes: 50 additions & 0 deletions scripts/proto_codegen_jaeger.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#!/bin/bash
#
# Regenerate python code from Jaeger protos in
# https://github.com/jaegertracing/jaeger-idl
#
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this file for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Submitted by accident. It's a script to regenerate jaeger protos. not needed for this PR.


set +e

PROTO_REPO_DIR=${PROTO_REPO_DIR:-"/tmp/proto_codegen_jaeger"}
# root of opentelemetry-python repo
repo_root="$(git rev-parse --show-toplevel)"
venv_dir="/tmp/proto_codegen_jaeger_venv"

# run on exit even if crash
cleanup() {
echo "Deleting $venv_dir"
rm -rf $venv_dir
}
trap cleanup EXIT

echo "Creating temporary virtualenv at $venv_dir using $(python3 --version)"
python3 -m venv $venv_dir
source $venv_dir/bin/activate
python -m pip install \
-c $repo_root/dev-requirements.txt \
grpcio-tools mypy-protobuf

# Clone the proto repo if it doesn't exist
if [ ! -d "$PROTO_REPO_DIR" ]; then
git clone https://github.com/jaegertracing/jaeger-idl.git ${PROTO_REPO_DIR}/jaeger-idl
git clone https://github.com/grpc-ecosystem/grpc-gateway ${PROTO_REPO_DIR}/grpc-gateway
git clone https://github.com/gogo/googleapis ${PROTO_REPO_DIR}/googleapis
git clone https://github.com/gogo/protobuf ${PROTO_REPO_DIR}/protobuf
fi

DEST="exporter/opentelemetry-exporter-jaeger-proto-grpc/src/opentelemetry/exporter/jaeger/proto/grpc/gen"

mkdir -p ${DEST}

# protoc ${PROTO_INCLUDES} --grpc_python_out=./python_out --python_out=./python_out ${DIR}/model.proto
python -m grpc_tools.protoc \
-I ${PROTO_REPO_DIR}/jaeger-idl/proto/api_v2 \
-I ${PROTO_REPO_DIR}/grpc-gateway \
-I ${PROTO_REPO_DIR}/googleapis \
-I ${PROTO_REPO_DIR}/protobuf/protobuf \
-I ${PROTO_REPO_DIR}/protobuf \
--grpc_python_out=./${DEST} \
--mypy_out=./${DEST} \
--python_out=./${DEST} \
${PROTO_REPO_DIR}/jaeger-idl/proto/api_v2/model.proto ${PROTO_REPO_DIR}/jaeger-idl/proto/api_v2/collector.proto
2 changes: 1 addition & 1 deletion shim/opentelemetry-opentracing-shim/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ packages=find_namespace:
install_requires =
Deprecated >= 1.2.6
opentracing ~= 2.0
opentelemetry-api == 1.4.0.dev0
opentelemetry-api ~= 1.3

[options.extras_require]
test =
Expand Down
4 changes: 2 additions & 2 deletions tests/util/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ package_dir=
=src
packages=find_namespace:
install_requires =
opentelemetry-api == 1.4.0.dev0
opentelemetry-sdk == 1.4.0.dev0
opentelemetry-api ~= 1.3
opentelemetry-sdk ~= 1.3

[options.extras_require]
test = flask~=1.0
Expand Down