mdBook: How to handle breaking releases, and how can we help users?
Current master has breaking changes to the configuration file. I expect there will be more breaking changes in the future as we improve and refactor mdBook. So we can’t guarantee stability. However, users might automate deployment of books through CI and we don’t want to break their deployments every time we make a breaking release!
So, can we figure out a way to pin CIs to a specific non-breaking version range of mdBook (like cargo does) so that the user can choose when to update to the breaking release?
Ideally we would need to come up with a solution that all the users can easily implement in Travis (or other CIs). Post it on the different forums and projects known to use mdBook and give some time to the users to migrate. Then we can release the 0.1.0 breaking release.
This issue is particularly relevant for the different books in the Rust community (TRPL2, Cookbook, …), I’m not sure how they handle deployments currently?
@steveklabnik @budziq @frewsxcv
Feel free to tag anyone who might have an interest in this discussion.
About this issue
- Original URL
- State: closed
- Created 7 years ago
- Comments: 20 (18 by maintainers)
Well I was talking about the Rust user forum 😄
I have made a PR to cargo rust-lang/cargo#4229 to add semver ranges to
cargo install --vers. Once this is merged we can start to recommend users to pin the version of mdBook like thisIt should already work with Cargo right now (with a deprecated warning) but if the PR gets merged we are guaranteed that this behaviour will stay and that the deprecated warning will go away in future releases.
Edit: PR has been merged into Cargo! 🎉
Yes, the same thing is used for all of the ones on doc.rust-lang.org.
On Wed, Jun 21, 2017 at 2:54 PM, Mathieu David notifications@github.com wrote: