From cf8b70e77b65686d6bc40db227e4af63ee336cf5 Mon Sep 17 00:00:00 2001 From: alrex Date: Fri, 29 Jan 2021 11:47:19 -0800 Subject: [PATCH] updating references to main (#1558) --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/workflows/changelog.yml | 4 ++-- .github/workflows/test.yml | 4 ++-- CONTRIBUTING.md | 18 +++++++++--------- README.md | 14 +++++++------- RELEASING.md | 16 ++++++++-------- docs/conf.py | 2 +- docs/examples/auto-instrumentation/README.rst | 2 +- docs/examples/django/README.rst | 2 +- docs/getting-started.rst | 6 +++--- docs/index.rst | 4 ++-- .../opentelemetry-exporter-jaeger/README.rst | 4 ++-- .../opentelemetry-exporter-jaeger/setup.cfg | 2 +- .../setup.cfg | 2 +- .../opentelemetry-exporter-otlp/README.rst | 2 +- exporter/opentelemetry-exporter-otlp/setup.cfg | 2 +- .../opentelemetry/exporter/otlp/__init__.py | 2 +- .../setup.cfg | 2 +- .../opentelemetry-exporter-zipkin/setup.cfg | 2 +- .../opentelemetry/exporter/zipkin/__init__.py | 2 +- opentelemetry-api/setup.cfg | 2 +- .../src/opentelemetry/metrics/__init__.py | 2 +- .../src/opentelemetry/propagators/__init__.py | 6 +++--- opentelemetry-distro/setup.cfg | 2 +- opentelemetry-instrumentation/setup.cfg | 2 +- .../opentelemetry/instrumentation/metric.py | 2 +- .../src/opentelemetry/instrumentation/utils.py | 2 +- .../tests/test_utils.py | 2 +- opentelemetry-proto/README.rst | 2 +- opentelemetry-proto/setup.cfg | 2 +- opentelemetry-sdk/setup.cfg | 2 +- .../opentelemetry/sdk/resources/__init__.py | 11 +++++------ .../opentelemetry/sdk/trace/ids_generator.py | 2 +- .../src/opentelemetry/sdk/trace/sampling.py | 2 +- .../opentelemetry-propagator-b3/setup.cfg | 2 +- .../opentelemetry-propagator-jaeger/setup.cfg | 2 +- scripts/prepare_release.sh | 6 +++--- shim/opentelemetry-opentracing-shim/setup.cfg | 2 +- 38 files changed, 73 insertions(+), 74 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 832b294a944..2597b185d06 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,7 +4,7 @@ about: Create a report to help us improve labels: bug --- -**Describe your environment** Describe any aspect of your environment relevant to the problem, including your Python version, [platform](https://docs.python.org/3/library/platform.html), version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on master. +**Describe your environment** Describe any aspect of your environment relevant to the problem, including your Python version, [platform](https://docs.python.org/3/library/platform.html), version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on main. **Steps to reproduce** Describe exactly how to reproduce the error. Include a code sample if applicable. diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 7e4b1032a7d..11e1a61fc54 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -1,4 +1,4 @@ -# This action requires that any PR targeting the master branch should touch at +# This action requires that any PR targeting the main branch should touch at # least one CHANGELOG file. If a CHANGELOG entry is not required, add the "Skip # Changelog" label to disable this action. @@ -8,7 +8,7 @@ on: pull_request: types: [opened, synchronize, reopened, labeled, unlabeled] branches: - - master + - main jobs: changelog: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a473fef774c..a276d606019 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -6,7 +6,7 @@ on: - 'release/*' pull_request: env: - # Set variable to 'master' if your change will not affect Contrib. + # Set variable to 'main' if your change will not affect Contrib. # Otherwise, set variable to the commit of your branch on # opentelemetry-python-contrib which is compatible with these Core repo # changes. @@ -82,7 +82,7 @@ jobs: alert-threshold: 200% fail-on-alert: true # Make a commit on `gh-pages` with benchmarks from previous step - auto-push: ${{ github.ref == 'refs/heads/master' }} + auto-push: ${{ github.ref == 'refs/heads/main' }} gh-pages-branch: gh-pages benchmark-data-dir-path: benchmarks misc: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7612cb8516c..c12c2e13ee3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,10 +8,10 @@ See the [public meeting notes](https://docs.google.com/document/d/1CIMGoIOZ-c3-i for a summary description of past meetings. To request edit access, join the meeting or get in touch on [Gitter](https://gitter.im/open-telemetry/opentelemetry-python). -See to the [community membership document](https://github.com/open-telemetry/community/blob/master/community-membership.md) -on how to become a [**Member**](https://github.com/open-telemetry/community/blob/master/community-membership.md#member), -[**Approver**](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver) -and [**Maintainer**](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer). +See to the [community membership document](https://github.com/open-telemetry/community/blob/main/community-membership.md) +on how to become a [**Member**](https://github.com/open-telemetry/community/blob/main/community-membership.md#member), +[**Approver**](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver) +and [**Maintainer**](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer). # Find your right repo @@ -63,7 +63,7 @@ You can run: - `tox -e lint` to run lint checks on all code See -[`tox.ini`](https://github.com/open-telemetry/opentelemetry-python/blob/master/tox.ini) +[`tox.ini`](https://github.com/open-telemetry/opentelemetry-python/blob/main/tox.ini) for more detail on available tox commands. ### Benchmarks @@ -144,7 +144,7 @@ to equal the commit SHA of the Core repo PR to pass tests equal the commit SHA of the Contrib repo PR to pass Contrib repo tests (a sanity check for the Maintainers & Approvers) 4. Merge the Contrib repo -5. Restore the Core repo PR `CONTRIB_REPO_SHA` to point to `master` +5. Restore the Core repo PR `CONTRIB_REPO_SHA` to point to `main` 6. Merge the Core repo PR ### How to Receive Comments @@ -156,8 +156,8 @@ check for the Maintainers & Approvers) ### How to Get PRs Merged A PR is considered to be **ready to merge** when: -* It has received two approvals from [Approvers](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver) - / [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer) +* It has received two approvals from [Approvers](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver) + / [Maintainers](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer) (at different companies). * Major feedbacks are resolved. * All tests are passing, including Contrib Repo tests which may require @@ -174,7 +174,7 @@ Any Approver / Maintainer can merge the PR once it is **ready to merge**. As with other OpenTelemetry clients, opentelemetry-python follows the [opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification). -It's especially valuable to read through the [library guidelines](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/library-guidelines.md). +It's especially valuable to read through the [library guidelines](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/library-guidelines.md). ### Focus on Capabilities, Not Structure Compliance diff --git a/README.md b/README.md index c131b62fe1c..eeb0ea231a2 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ GitHub release (latest by date including pre-releases) - + Codecov Status - + license
@@ -61,7 +61,7 @@ pip install opentelemetry-sdk ``` The -[`instrumentation/`](https://github.com/open-telemetry/opentelemetry-python/tree/master/instrumentation) +[`instrumentation/`](https://github.com/open-telemetry/opentelemetry-python/tree/main/instrumentation) directory includes OpenTelemetry instrumentation packages. You can install the packages separately with the following command: ```sh @@ -69,7 +69,7 @@ pip install opentelemetry-instrumentation-{instrumentation} ``` The -[`exporter/`](https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter) +[`exporter/`](https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter) directory includes OpenTelemetry exporter packages. You can install the packages separately with the following command: ```sh @@ -77,7 +77,7 @@ pip install opentelemetry-exporter-{exporter} ``` The -[`propagator/`](https://github.com/open-telemetry/opentelemetry-python/tree/master/propagator) +[`propagator/`](https://github.com/open-telemetry/opentelemetry-python/tree/main/propagator) directory includes OpenTelemetry propagator packages. You can install the packages separately with the following command: ```sh @@ -125,14 +125,14 @@ Approvers ([@open-telemetry/python-approvers](https://github.com/orgs/open-telem - [Reiley Yang](https://github.com/reyang), Microsoft - [Yusuke Tsutsumi](https://github.com/toumorokoshi), Google -*For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver).* +*For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver).* Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-telemetry/teams/python-maintainers)): - [Alex Boten](https://github.com/codeboten), Lightstep - [Leighton Chen](https://github.com/lzchen), Microsoft -*For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).* +*For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).* ### Thanks to all the people who already contributed! diff --git a/RELEASING.md b/RELEASING.md index efee93b39fa..a16777987e7 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -7,7 +7,7 @@ Release Process: * [Open a Pull Request](#open-a-pull-request) * [Create a Release](#Create-a-Release) * [Move stable tag](#Move-stable-tag) -* [Update master](#Update-master) +* [Update main](#Update-main) * [Check PyPI](#Check-PyPI) * [Troubleshooting](#troubleshooting) @@ -16,7 +16,7 @@ Release Process: ## Create a new branch The following script does the following: -- update master locally +- update main locally - creates a new release branch `release/` - updates version and changelog files - commits the change to a new branch `release/-auto` @@ -39,7 +39,7 @@ The PR should be opened from the `release/-auto` branch created as part ## Check PyPI -This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python/blob/master/.github/workflows/publish.yml). +This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python/blob/main/.github/workflows/publish.yml). - Check the [action logs](https://github.com/open-telemetry/opentelemetry-python/actions?query=workflow%3APublish) to make sure packages have been uploaded to PyPI - Check the release history (e.g. https://pypi.org/project/opentelemetry-api/#history) on PyPI @@ -58,18 +58,18 @@ git push origin stable To validate this worked, ensure the stable build has run successfully: https://readthedocs.org/projects/opentelemetry-python/builds/. If the build has not run automatically, it can be manually trigger via the readthedocs interface. -## Update master +## Update main -Ensure the version and changelog updates have been applied to master. +Ensure the version and changelog updates have been applied to main. ```bash -# checkout a new branch from master -git checkout -b v0.7b0-master-update +# checkout a new branch from main +git checkout -b v0.7b0-main-update # cherry pick the change from the release branch git cherry-pick $(git log -n 1 origin/release/0.7b0 --format="%H") # update the version number, make it a "dev" greater than release number, e.g. 0.8.dev0 perl -i -p -e 's/0.7b0/0.8.dev0/' $(git grep -l "0.7b0" | grep -vi CHANGELOG) -# open a PR targeting master see #331 +# open a PR targeting main see #331 git commit -m ``` diff --git a/docs/conf.py b/docs/conf.py index 1da52b4a6d3..42eefa1ce1c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -144,7 +144,7 @@ # Support external links to specific versions of the files in the Github repo branch = os.environ.get("READTHEDOCS_VERSION") if branch is None or branch == "latest": - branch = "master" + branch = "main" REPO = "open-telemetry/opentelemetry-python/" scm_raw_web = "https://raw.githubusercontent.com/" + REPO + branch diff --git a/docs/examples/auto-instrumentation/README.rst b/docs/examples/auto-instrumentation/README.rst index d7e59eedefc..f85106b66d8 100644 --- a/docs/examples/auto-instrumentation/README.rst +++ b/docs/examples/auto-instrumentation/README.rst @@ -11,7 +11,7 @@ The example is based on a previous OpenTracing example that you can find `here `__. -The source files for these examples are available `here `__. +The source files for these examples are available `here `__. This example uses two different scripts. The main difference between them is whether or not they're instrumented manually: diff --git a/docs/examples/django/README.rst b/docs/examples/django/README.rst index 4545dd57b3a..0e5606c6dab 100644 --- a/docs/examples/django/README.rst +++ b/docs/examples/django/README.rst @@ -111,4 +111,4 @@ References * `Django `_ * `OpenTelemetry Project `_ -* `OpenTelemetry Django extension `_ +* `OpenTelemetry Django extension `_ diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 228e254df60..f2cd75717fe 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -3,7 +3,7 @@ Getting Started with OpenTelemetry Python This guide walks you through instrumenting a Python application with ``opentelemetry-python``. -For more elaborate examples, see `examples `_. +For more elaborate examples, see `examples `_. Hello world: emit a trace to your console --------------------------------------------- @@ -149,7 +149,7 @@ While the example in the previous section is great, it's very manual. The follow * Database calls To track these common actions, OpenTelemetry has the concept of instrumentations. Instrumentations are packages designed to interface -with a specific framework or library, such as Flask and psycopg2. You can find a list of the currently curated extension packages in the `Contrib repository `_. +with a specific framework or library, such as Flask and psycopg2. You can find a list of the currently curated extension packages in the `Contrib repository `_. Instrument a basic Flask application that uses the requests library to send HTTP requests. First, install the instrumentation packages themselves: @@ -180,7 +180,7 @@ A major feature of distributed tracing is the ability to correlate a trace acros multiple services. However, those services need to propagate information about a trace from one service to the other. -To enable this propagation, OpenTelemetry has the concept of `propagators `_, +To enable this propagation, OpenTelemetry has the concept of `propagators `_, which provide a common method to encode and decode span information from a request and response, respectively. By default, ``opentelemetry-python`` is configured to use the `W3C Trace Context `_ diff --git a/docs/index.rst b/docs/index.rst index eb62e6a0092..66797a3a748 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,8 +32,8 @@ In addition, there are several extension packages which can be installed separat These are for exporter and instrumentation packages respectively. Some packages can be found in :scm_web:`instrumentation ` and :scm_web:`exporter ` directory of the repository. The remaining packages can be found at the -`Contrib repo instrumentation `_ -and `Contrib repo exporter `_ directories. +`Contrib repo instrumentation `_ +and `Contrib repo exporter `_ directories. Extensions ---------- diff --git a/exporter/opentelemetry-exporter-jaeger/README.rst b/exporter/opentelemetry-exporter-jaeger/README.rst index 8a9b6b08197..67798395a3f 100644 --- a/exporter/opentelemetry-exporter-jaeger/README.rst +++ b/exporter/opentelemetry-exporter-jaeger/README.rst @@ -23,9 +23,9 @@ Configuration ------------- OpenTelemetry Jaeger Exporter can be configured by setting `JaegerSpanExporter parameters -`_ or by setting -`environment variables `_ References diff --git a/exporter/opentelemetry-exporter-jaeger/setup.cfg b/exporter/opentelemetry-exporter-jaeger/setup.cfg index 040c4d5a639..c5fa47b2d65 100644 --- a/exporter/opentelemetry-exporter-jaeger/setup.cfg +++ b/exporter/opentelemetry-exporter-jaeger/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter/opentelemetry-exporter-jaeger +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-jaeger platforms = any license = Apache-2.0 classifiers = diff --git a/exporter/opentelemetry-exporter-opencensus/setup.cfg b/exporter/opentelemetry-exporter-opencensus/setup.cfg index 02b277e17ed..9c8dc747ddf 100644 --- a/exporter/opentelemetry-exporter-opencensus/setup.cfg +++ b/exporter/opentelemetry-exporter-opencensus/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter/opentelemetry-exporter-opencensus +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-opencensus platforms = any license = Apache-2.0 classifiers = diff --git a/exporter/opentelemetry-exporter-otlp/README.rst b/exporter/opentelemetry-exporter-otlp/README.rst index 8adf6571815..bd3b581e1db 100644 --- a/exporter/opentelemetry-exporter-otlp/README.rst +++ b/exporter/opentelemetry-exporter-otlp/README.rst @@ -22,4 +22,4 @@ References * `OpenTelemetry Collector Exporter `_ * `OpenTelemetry Collector `_ * `OpenTelemetry `_ -* `OpenTelemetry Protocol Specification `_ +* `OpenTelemetry Protocol Specification `_ diff --git a/exporter/opentelemetry-exporter-otlp/setup.cfg b/exporter/opentelemetry-exporter-otlp/setup.cfg index 9e2be8636fc..23eb724df4d 100644 --- a/exporter/opentelemetry-exporter-otlp/setup.cfg +++ b/exporter/opentelemetry-exporter-otlp/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter/opentelemetry-exporter-otlp +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-otlp platforms = any license = Apache-2.0 classifiers = diff --git a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py index 1094be286db..abc4186b71b 100644 --- a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py +++ b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py @@ -34,7 +34,7 @@ be in the format of a string "gzip" for gzip compression, and no value specified if no compression is the desired choice. Additional details are available `in the specification -`_. +`_. .. code:: python diff --git a/exporter/opentelemetry-exporter-prometheus/setup.cfg b/exporter/opentelemetry-exporter-prometheus/setup.cfg index 3c6720337aa..f8f463c257b 100644 --- a/exporter/opentelemetry-exporter-prometheus/setup.cfg +++ b/exporter/opentelemetry-exporter-prometheus/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter/opentelemetry-exporter-prometheus +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-prometheus platforms = any license = Apache-2.0 classifiers = diff --git a/exporter/opentelemetry-exporter-zipkin/setup.cfg b/exporter/opentelemetry-exporter-zipkin/setup.cfg index 2b4c642dee1..45cdb034367 100644 --- a/exporter/opentelemetry-exporter-zipkin/setup.cfg +++ b/exporter/opentelemetry-exporter-zipkin/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/exporter/opentelemetry-exporter-zipkin +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-zipkin platforms = any license = Apache-2.0 classifiers = diff --git a/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py b/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py index 387e33d5944..3f1984b8a85 100644 --- a/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py +++ b/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py @@ -24,7 +24,7 @@ .. _Zipkin: https://zipkin.io/ .. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/ -.. _Specification: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/sdk-environment-variables.md#zipkin-exporter +.. _Specification: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#zipkin-exporter .. envvar:: OTEL_EXPORTER_ZIPKIN_ENDPOINT .. envvar:: OTEL_EXPORTER_ZIPKIN_TRANSPORT_FORMAT diff --git a/opentelemetry-api/setup.cfg b/opentelemetry-api/setup.cfg index 7deb389f18b..20efac052d0 100644 --- a/opentelemetry-api/setup.cfg +++ b/opentelemetry-api/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/opentelemetry-api +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-api platforms = any license = Apache-2.0 classifiers = diff --git a/opentelemetry-api/src/opentelemetry/metrics/__init__.py b/opentelemetry-api/src/opentelemetry/metrics/__init__.py index 227a02bc35a..325d0550239 100644 --- a/opentelemetry-api/src/opentelemetry/metrics/__init__.py +++ b/opentelemetry-api/src/opentelemetry/metrics/__init__.py @@ -25,7 +25,7 @@ See the `metrics api`_ spec for terminology and context clarification. .. _metrics api: - https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/metrics/api.md + https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md """ import abc from logging import getLogger diff --git a/opentelemetry-api/src/opentelemetry/propagators/__init__.py b/opentelemetry-api/src/opentelemetry/propagators/__init__.py index fb2863ac8ad..5c42075e3c1 100644 --- a/opentelemetry-api/src/opentelemetry/propagators/__init__.py +++ b/opentelemetry-api/src/opentelemetry/propagators/__init__.py @@ -65,7 +65,7 @@ def example_route(): .. _Propagation API Specification: - https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md + https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/api-propagators.md """ import typing @@ -86,7 +86,7 @@ def extract( carrier: textmap.TextMapPropagatorT, context: typing.Optional[Context] = None, ) -> Context: - """ Uses the configured propagator to extract a Context from the carrier. + """Uses the configured propagator to extract a Context from the carrier. Args: getter: an object which contains a get function that can retrieve zero @@ -107,7 +107,7 @@ def inject( carrier: textmap.TextMapPropagatorT, context: typing.Optional[Context] = None, ) -> None: - """ Uses the configured propagator to inject a Context into the carrier. + """Uses the configured propagator to inject a Context into the carrier. Args: set_in_carrier: A setter function that can set values diff --git a/opentelemetry-distro/setup.cfg b/opentelemetry-distro/setup.cfg index ed6cb82545c..d2a40b0e040 100644 --- a/opentelemetry-distro/setup.cfg +++ b/opentelemetry-distro/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/opentelemetry-distro +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-distro platforms = any license = Apache-2.0 classifiers = diff --git a/opentelemetry-instrumentation/setup.cfg b/opentelemetry-instrumentation/setup.cfg index 825b1ad2adc..0ebc59d2db8 100644 --- a/opentelemetry-instrumentation/setup.cfg +++ b/opentelemetry-instrumentation/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/opentelemetry-instrumentation +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-instrumentation platforms = any license = Apache-2.0 classifiers = diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/metric.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/metric.py index 107d5a49fdc..4f8972ac826 100644 --- a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/metric.py +++ b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/metric.py @@ -75,7 +75,7 @@ def __init__( ) # Conventions for recording duration can be found at: - # https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/metrics/semantic_conventions/http-metrics.md + # https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/http-metrics.md @contextmanager def record_client_duration(self, labels: Dict[str, str]): start_time = time() diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py index f0ebc042b1f..49386f1dddd 100644 --- a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py +++ b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py @@ -40,7 +40,7 @@ def http_status_to_status_code( Args: status (int): HTTP status code """ - # See: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/http.md#status + # See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#status if status < 100: return StatusCode.ERROR if status <= 299: diff --git a/opentelemetry-instrumentation/tests/test_utils.py b/opentelemetry-instrumentation/tests/test_utils.py index edd23204734..bcbf6eced00 100644 --- a/opentelemetry-instrumentation/tests/test_utils.py +++ b/opentelemetry-instrumentation/tests/test_utils.py @@ -20,7 +20,7 @@ class TestUtils(TestBase): - # See https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/http.md#status + # See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#status def test_http_status_to_status_code(self): for status_code, expected in ( (HTTPStatus.OK, StatusCode.UNSET), diff --git a/opentelemetry-proto/README.rst b/opentelemetry-proto/README.rst index 6825aa88238..d8cff6e68c6 100644 --- a/opentelemetry-proto/README.rst +++ b/opentelemetry-proto/README.rst @@ -32,4 +32,4 @@ References * `OpenTelemetry Project `_ * `OpenTelemetry Proto `_ -* `proto_codegen.sh script `_ +* `proto_codegen.sh script `_ diff --git a/opentelemetry-proto/setup.cfg b/opentelemetry-proto/setup.cfg index 6b924a7a390..9934a7c5ece 100644 --- a/opentelemetry-proto/setup.cfg +++ b/opentelemetry-proto/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/opentelemetry-proto +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-proto platforms = any license = Apache-2.0 classifiers = diff --git a/opentelemetry-sdk/setup.cfg b/opentelemetry-sdk/setup.cfg index 4108b3efa8f..719911ffcbb 100644 --- a/opentelemetry-sdk/setup.cfg +++ b/opentelemetry-sdk/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/opentelemetry-sdk +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-sdk platforms = any license = Apache-2.0 classifiers = diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py index 2b832cff7d0..74d57439f31 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py @@ -14,7 +14,7 @@ """ This package implements `OpenTelemetry Resources -`_: +`_: *A Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in @@ -49,7 +49,7 @@ 'service.instance.id': 'instance-12'} Note that the OpenTelemetry project documents certain `"standard attributes" -`_ +`_ that have prescribed semantic meanings, for example ``service.name`` in the above example. @@ -61,7 +61,7 @@ `Resource.create`, meaning :envvar:`OTEL_RESOURCE_ATTRIBUTES` takes *lower* priority. Attributes should be in the format ``key1=value1,key2=value2``. Additional details are available `in the specification -`_. +`_. .. code-block:: console @@ -155,8 +155,7 @@ class Resource: - """A Resource is an immutable representation of the entity producing telemetry as Attributes. - """ + """A Resource is an immutable representation of the entity producing telemetry as Attributes.""" def __init__(self, attributes: Attributes): self._attributes = attributes.copy() @@ -260,7 +259,7 @@ def get_aggregated_resources( initial_resource: typing.Optional[Resource] = None, timeout=5, ) -> "Resource": - """ Retrieves resources from detectors in the order that they were passed + """Retrieves resources from detectors in the order that they were passed :param detectors: List of resources in order of priority :param initial_resource: Static resource. This has highest priority diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/ids_generator.py b/opentelemetry-sdk/src/opentelemetry/sdk/trace/ids_generator.py index 31e1fee0788..4e2a81b7318 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/trace/ids_generator.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/trace/ids_generator.py @@ -33,7 +33,7 @@ def generate_trace_id(self) -> int: uniformly random. Samplers like the `TraceIdRatioBased` sampler rely on this randomness to make sampling decisions. - See `the specification on TraceIdRatioBased `_. + See `the specification on TraceIdRatioBased `_. Returns: A 128-bit int for use as a trace ID diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py b/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py index b6475c4d345..bb174233542 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py @@ -13,7 +13,7 @@ # limitations under the License. """ -For general information about sampling, see `the specification `_. +For general information about sampling, see `the specification `_. OpenTelemetry provides two types of samplers: diff --git a/propagator/opentelemetry-propagator-b3/setup.cfg b/propagator/opentelemetry-propagator-b3/setup.cfg index 9da95c16a95..903117996ce 100644 --- a/propagator/opentelemetry-propagator-b3/setup.cfg +++ b/propagator/opentelemetry-propagator-b3/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/propagator/opentelemetry-propagator-b3 +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/propagator/opentelemetry-propagator-b3 platforms = any license = Apache-2.0 classifiers = diff --git a/propagator/opentelemetry-propagator-jaeger/setup.cfg b/propagator/opentelemetry-propagator-jaeger/setup.cfg index 255813b5794..c94e3e8b495 100644 --- a/propagator/opentelemetry-propagator-jaeger/setup.cfg +++ b/propagator/opentelemetry-propagator-jaeger/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/propagator/opentelemetry-propagator-jaeger +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/propagator/opentelemetry-propagator-jaeger platforms = any license = Apache-2.0 classifiers = diff --git a/scripts/prepare_release.sh b/scripts/prepare_release.sh index e75278eb5e5..09b934420de 100755 --- a/scripts/prepare_release.sh +++ b/scripts/prepare_release.sh @@ -22,9 +22,9 @@ if [[ ! "${VERSION}" =~ ^([0-9])(\.*[0-9]{1,5}[a-b]*){1,3}$ ]]; then fi # create the release branch -git fetch origin master -git checkout master -git reset --hard origin/master +git fetch origin main +git checkout main +git reset --hard origin/main git checkout -b release/${VERSION} git push origin release/${VERSION} diff --git a/shim/opentelemetry-opentracing-shim/setup.cfg b/shim/opentelemetry-opentracing-shim/setup.cfg index 8a7b0cfcced..667a9e5a4c3 100644 --- a/shim/opentelemetry-opentracing-shim/setup.cfg +++ b/shim/opentelemetry-opentracing-shim/setup.cfg @@ -19,7 +19,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst author = OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/open-telemetry/opentelemetry-python/tree/master/instrumentation/opentelemetry-instrumentation-opentracing-shim +url = https://github.com/open-telemetry/opentelemetry-python/tree/main/instrumentation/opentelemetry-instrumentation-opentracing-shim platforms = any license = Apache-2.0 classifiers =