Skip to content

Commit 64f6f78

Browse files
authored
Merge pull request #385 from azerupi/readme-pin-ci
Add a note about version pinning in the README
2 parents 6ab3d3d + 3b0d2d1 commit 64f6f78

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ There are multiple ways to install mdBook.
4343

4444
This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`.
4545

46+
**Note for automatic deployment**
47+
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!
48+
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:
49+
50+
```
51+
cargo install mdbook --vers "^0.1.0"
52+
```
53+
4654
3. **From Git**
4755
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***!
4856

0 commit comments

Comments
 (0)