brson / brson/rust-anthology

Pin version of mdBook

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
1.5k
Forks
49
PR merge metrics
No merged PRs in 30d

Description

Hi!

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
``` bash
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.

Contributor guide

Open the contributing guide

Research direction

Find the deployment script or configuration containing `cargo install mdbook`; the issue does not name a file. Check how the repository currently installs mdBook, pin it to `^0.0.22`, and verify that the deployment configuration still installs the intended version.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, shell
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.