open-telemetry / open-telemetry/opentelemetry-python-contrib

Releasing Packages in Contrib as 1.0 Stable

Open
#591 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request triaged
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

Description

This issue came out as a result of the 2021-07-15 SIG Meeting Discussion.

Many other languages are already going to 1.0 for their contrib packages. See:

We also want to pave the way for individual contrib packages to be released as 1.0 for Python. This will allow companies/users to take dependencies on the useful packages in the contrib repository.

Reasons we are ready to go to 1.0:

  • Semantic Conventions is already at version 1.5.0
    • Trace APIs are stable, only attributes are still experimental
    • For minor changes, they are providing schema files as a migration guide that SDKs/backends can use to find attributes as they change value/key.
  • Our contrib packages already pin the version of opentelemetry-semantic-conventions they use which will allow them to move at their own pace (Go SDK does this)

Remaining Issues

In order to release packages in opentelemetry-python-contrib as 1.0 and therefore "stable", we want the following issues to be resolved:

Nice to Have Issues

  • CODEOWNERS of packages can release (not merge updates) packages independent of maintainers (e.g. using GitHub Actions & Tags?)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing issues 550, 589, and 590, then read the linked 2021-07-15 SIG Meeting Discussion. Determine the requirements for releasing individual contrib packages as 1.0 and document how those remaining issues should be resolved; completion is agreement on a release path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.