search

clap-rs / clap-book

A book detailing how to build command line applications in Rust
Apache License 2.0
13 stars 3 forks source link

Pin version of mdBook #4

Closed azerupi closed 7 years ago

azerupi commented 7 years ago

Hi!

I'm not sure if this applies to this repo because I don't know if you deploy the book automatically?

We would like to issue a new release of mdBook containing some changes that could potentially break current books, the config file changed a bit for example. However we found out that a lot of projects automatically deploy using the latest available version and so any breaking update could result in books not being deployed anymore..

We would like to avoid that and recommend pinning the version of mdBook in your deployment script. Cargo supports semver ranges on cargo install (right now it issues a deprecation warning, but in the future this warning should go away thanks to rust-lang/cargo#4229)

You can thus simply change cargo install mdbook to

cargo install mdbook --vers "^0.0.22"

Next release will be 0.1.0 and we will try to adhere to semver as much as possible.

For more info, azerupi/mdBook#327 is the tracking issue on our repository.

kbknapp commented 7 years ago

Thanks or the heads up! I haven't worked on this in a few months, and it probably doesn't apply to this repo directly, but I really appreciate you reaching out! :+1: