open-telemetry / open-telemetry/opentelemetry-cpp
[DOC] Upgrade for each dependency is hard to maintain
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.4k
- Forks
- 632
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 75
Description
In light of #2676 and #2677, it turns out upgrading each dependency is not trivial, because versions numbers for each dependencies are spread in multiple files in the source code, some of them long forgotten and easy to overlook.
In this case, opentelemetry-proto was updated to 1.3.1 in a few places, but left as 1.1.0 in others.
Provide maintainers documentation that lists exhaustively, for each dependency:
- where the dependency comes from
- what are the minimal version requirements
- which files needs to be updated
- which special build or tests need to be considered
- anything else relevant for maintainers
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
Review issues #2676 and #2677, then inspect the repository for dependency version declarations, starting with the files where opentelemetry-proto is recorded as 1.3.1 or 1.1.0. Document each dependency's source, minimum version, update locations, special builds or tests, and other maintainer requirements; done means the inventory is exhaustive and usable during upgrades.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100