Add a GitHub Actions workflow to check the book

ChorusOne · May 22, 2024 · 63ad957 · 63ad957
1 parent 11dabf5
commit 63ad957
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -0,0 +1,22 @@
+name: Check
+
+"on":
+  workflow_dispatch: {}
+  pull_request:
+    branches: ["*"]
+
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install mdBook
+        run: |
+          curl -sSL https://github.com/rust-lang/mdBook/releases/download/$(cat mdbook-version)/mdbook-$(cat mdbook-version)-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
+
+      - name: Build and test the book
+        run: |
+          bin/mdbook build
+          bin/mdbook test
diff --git a/README.md b/README.md
@@ -15,6 +15,8 @@ details. To start a local preview server:
 
     mdbook serve
 
+The exact version of mdBook to use is listed in the `mdbook-version` file.
+
 [mdBook]: https://rust-lang.github.io/mdBook/index.html
 
 ## Contributing

diff --git a/mdbook-version b/mdbook-version
@@ -0,0 +1 @@
+v0.4.37