ci: add msrv to cargo toml, update mdbook version

chore: prep v0.13.0 release

CHANGELOG.md

@@ -2,17 +2,28 @@
 
 ## Unreleased
 
+## 1.13.0
+
+### Changed
+
+- Required styles version is now `^3.0.0` (release `1.13.0`). Run `mdbook-admonish install` to update.
+- Internal CSS classnames for directives are now prefixed with `admonish-`, so `warning` is now `admonish-warning`. This avoids a conflict with upstream classnames introduced in `mdbook 0.4.35`. Thanks to [@phoenixr-codes](https://github.com/phoenixr-codes) for the report and fix! ([#139](https://github.com/tommilligan/mdbook-admonish/pull/139))
+
+### Fixed
+
+- Some minor inconsistencies in SCSS (and downstream CSS) styles were fixed by adopting Prettier linting ([#138](https://github.com/tommilligan/mdbook-admonish/pull/138))
+
 ## 1.12.1
 
 ### Fixed
 
-- Panic when searching for an indent in non-ASCII content. Thanks to [@CoralPink](https://github.com/CoralPink) for the report! ([#128](https://github.com/tommilligan/mdbook-admonish/pull/128)
+- Panic when searching for an indent in non-ASCII content. Thanks to [@CoralPink](https://github.com/CoralPink) for the report! ([#128](https://github.com/tommilligan/mdbook-admonish/pull/128))
 
 ## 1.12.0
 
 ### Added
 
-- Admonitions are now supported when indented inside other elements, such as a list. Thanks to [@mattburgess](https://github.com/mattburgess) for the report! ([#124](https://github.com/tommilligan/mdbook-admonish/pull/124)
+- Admonitions are now supported when indented inside other elements, such as a list. Thanks to [@mattburgess](https://github.com/mattburgess) for the report! ([#124](https://github.com/tommilligan/mdbook-admonish/pull/124))
 
 ## 1.11.1
 

Cargo.lock

@@ -952,7 +952,7 @@ dependencies = [
 
 [[package]]
 name = "mdbook-admonish"
-version = "1.12.1"
+version = "1.13.0"
 dependencies = [
  "anyhow",
  "clap",

Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "mdbook-admonish"
-version = "1.12.1"
+version = "1.13.0"
 edition = "2021"
+rust-version = "1.66.0"
 
 authors = ["Tom Milligan <code@tommilligan.net>"]
 description = "A preprocessor for mdbook to add Material Design admonishments."
@@ -27,7 +28,9 @@ path = "src/lib.rs"
 [dependencies]
 anyhow = "1.0.75"
 # Note: clap 4.4 increases MSRV to 1.70.0 (2023-06-01)
-clap = { version = "~4.3", default_features = false, features = ["std", "derive"], optional = true }
+# To use MSRV supported dependencies, install using the lockfile with
+# `cargo install mdbook-admonish --locked`
+clap = { version = "4.3", default_features = false, features = ["std", "derive"], optional = true }
 env_logger = { version = "0.10", default_features = false, optional = true }
 log = "0.4.20"
 mdbook = "0.4.35"

README.md

@@ -70,6 +70,9 @@ Install the tool:
 
 ```bash
 cargo install mdbook-admonish
+
+# If you get compilation/installation errors, try a locked installation
+cargo install mdbook-admonish --locked
 ```
 
 Then let `mdbook-admonish` add the required files and configuration:
@@ -101,6 +104,21 @@ Then, build your book as usual:
 mdbook path/to/book
 ```
 
+### Reproducible builds
+
+For a reproducible build suitable for use in CI or scripts, please:
+
+- Pin to a specific version
+- Install with lockfile dependencies
+- Always install the latest CSS assets
+
+```bash
+cargo install mdbook-admonish --vers "1.5.0" --locked
+mdbook-admonish install path/to/your/book
+```
+
+The Minimum Supported Rust Version (MSRV) is documented in `Cargo.toml`, and noted in the `CHANGELOG.md`. We aims to support around six months of stable Rust.
+
 ### Updates
 
 **Please note**, when updating your version of `mdbook-admonish`, updated styles will not be applied unless you rerun `mdbook-admonish install` to update the additional CSS files in your book.
@@ -117,12 +135,6 @@ ERROR:
 
 If you want to update across minor versions without breakage, you should always run `mdbook-admonish install`.
 
-Alternatively, pin to a specific version for a reproducible installation:
-
-```bash
-cargo install mdbook-admonish --vers "1.5.0" --locked
-```
-
 ### Process included files
 
 You can ensure that content inlined with `{{#include}}` is also processed by [setting the `after` option](https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html#require-a-certain-order):

scripts/install-mdbook

@@ -1,9 +1,18 @@
 #!/bin/bash
 
-set -exuo pipefail
+set -euo pipefail
 
 cd "$(dirname "$0")"/..
 
-if ! mdbook --version; then
-  cargo install mdbook --version 0.4.32 --force
+function eprintln() {
+  >&2 echo "$1"
+}
+
+VERSION="0.4.35"
+
+eprintln "Checking if mdbook $VERSION is installed"
+if [[ "$(mdbook --version)" != "mdbook v$VERSION" ]]; then
+  eprintln "Installing mdbook $VERSION"
+  cargo install mdbook --version "$VERSION" --force
 fi
+eprintln "mdbook $VERSION is installed"