Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Figure out a strategy for updating public dependencies #2387

Open
ehuss opened this issue May 17, 2024 · 2 comments
Open

Figure out a strategy for updating public dependencies #2387

ehuss opened this issue May 17, 2024 · 2 comments
Labels
A-API Area: API

Comments

@ehuss
Copy link
Contributor

ehuss commented May 17, 2024

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 .hbs files are interpreted differently, or broken.
@max-sixty
Copy link
Contributor

Would upgrading them and publishing an mdbook 0.5.0 make sense?

We're currently locked on an older version of pulldown-cmark in PRQL since we're pinned to the mdbook version...

Thank you!

@danieleades
Copy link
Contributor

danieleades commented Aug 5, 2024

these are all leaky abstractions. It makes sense to release a new major version of md book that hides these abstractions behind interfaces so that future breaking changes can be avoided.

see #2037

using deprecations would be a nice way to help users migrate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-API Area: API
Projects
None yet
Development

No branches or pull requests

3 participants