open-telemetry / open-telemetry/opentelemetry-python-contrib
test that `scripts/eachdist.py` version bump makes sense
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
At release time we run scripts/eachdist.py to bump the package versions. Packages released independently should be excluded from this bump since they are doing their own versioning.
For 1.40.0 two genai instrumentation were missing from the exclude_release group in eachdist.ini and so their version was wrongly bumped in the prerelease workflow.
I'm not sure what consequences not catching this would have had, maybe a failure in the release step or maybe an upload of package with the wrong version.
To avoid this in the future we may add a test in CI that checks the the eventual bump make sense, a simple check can be that the new version is bigger than the current one and that is current+1. We need also a label to skip the check if that's what we really want to do.
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 reading scripts/eachdist.py and eachdist.ini, then inspect the prerelease workflow and existing CI checks. Determine how independently released packages are represented and how a check could compare current and bumped versions, including the proposed opt-out label. Done means the CI behavior and any intentional-skip path are defined and tested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100