mdBook icon indicating copy to clipboard operation
mdBook copied to clipboard

Figure out a strategy for updating public dependencies

Open ehuss opened this issue 1 year ago • 2 comments
trafficstars

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.

ehuss avatar May 17 '24 01:05 ehuss

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!

max-sixty avatar Jul 15 '24 18:07 max-sixty

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 https://github.com/rust-lang/mdBook/issues/2037

using deprecations would be a nice way to help users migrate

danieleades avatar Aug 05 '24 10:08 danieleades