open-telemetry / open-telemetry/opentelemetry-python
Issues when releasting patch releases
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
When releasing 1.41.1 I have found a couple of issues:
-
contrib tests environments are from main: https://github.com/open-telemetry/opentelemetry-python/blob/main/.github/workflows/ci.yml#L27. So we have no guarantee that the environments referenced in main is available in the release branch. In this case after dropping 3.9 support the main tox.ini had a couple of combinations that are missing in the release branch.
Available workaround: we can update the version in the template and in the rendered workflow so that we run the proper tests -
public-symbols-check: api changes are compared against main and not against the branch
Available workaround: use the Approve Public API check label
Nothing severe but if a fix is not available we should document the issues in RELEASING.md.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing .github/workflows/ci.yml and tox.ini between main and a patch release branch, then inspect the public-symbols-check configuration. Done means release workflows use branch-appropriate environments and API comparisons, or RELEASING.md documents the stated workarounds if fixes are not feasible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, devops, release
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100