actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a note about version pinning for people doing automatic deployments of their books

This commit is contained in:
Mathieu David 2017-08-01 14:16:39 +02:00
parent 6ab3d3da2a
commit 3b0d2d1238
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -43,6 +43,14 @@ There are multiple ways to install mdBook.
This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`. This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`.
**Note for automatic deployment**
If you are using a script to do automatic deployments using Travis or another CI server, we recommend that you specify a semver version range for mdBook when you install it through your script!
This will constrain the server to install the latests **non-breaking** version of mdBook and will prevent your books from failing to build because we released a new version. For example:
```
cargo install mdbook --vers "^0.1.0"
```
3. **From Git** 3. **From Git**
The version published to crates.io will ever so slightly be behind the version hosted here on GitHub. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***! The version published to crates.io will ever so slightly be behind the version hosted here on GitHub. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***!