Figure out a strategy for updating public dependencies
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
We are currently not able to update public dependencies exposed in the API due to semver breakage. There probably should be some strategy for how to handle this. For example, public re-exporting the crates so that users can keep the version in sync. Another alternative is to hide these via wrappers or shrinking the number of pub items.
Currently this affects:
- anyhow
- toml
- pulldown-cmark
Separately, backwards-incompatible behavioral changes in some dependencies may impact compatibility in a way that can't be detected automatically, such as:
- handlebars: If
.hbsfiles are interpreted differently, or broken.
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 reviewing the public API surfaces involving anyhow, toml, pulldown-cmark, and handlebars, then compare the proposed re-export, wrapper, and reduced-public-item approaches. Done means agreeing on a dependency compatibility strategy that addresses semver breakage and backwards-incompatible behavioral changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100