Merge #604

604: docs: make mdBook emit error codes r=korken89 a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@grepit.se>

.github/workflows/build.yml

@@ -458,10 +458,12 @@ jobs:
           mdbook-version: 'latest'
 
       - name: Build book in English
-        run: cd book/en && mdbook build
+        shell: 'script --return --quiet --command "bash {0}"'
+        run: cd book/en && if mdbook build |& tee /dev/tty | grep "\[ERROR\]"; then exit 1; else exit 0; fi
 
       - name: Build book in Russian
-        run: cd book/ru && mdbook build
+        shell: 'script --return --quiet --command "bash {0}"'
+        run: cd book/ru && if mdbook build |& tee /dev/tty | grep "\[ERROR\]"; then echo "Russian book needs updating!"; else exit 0; fi
 
       - name: Check links
         run: |
@@ -518,6 +520,7 @@ jobs:
         run: cargo doc
 
       - name: Build books
+        shell: 'script --return --quiet --command "bash {0}"'
         run: |
           langs=( en ru )
           devver=( dev )
@@ -549,7 +552,9 @@ jobs:
 
           # Build books
           for lang in ${langs[@]}; do
-              ( cd book/$lang && mdbook build )
+              ( cd book/$lang &&
+                if mdbook build |& tee /dev/tty | grep "\[ERROR\]"; then exit 1; else exit 0; fi
+              )
               cp -r book/$lang/book $td/$devver/book/$lang
               cp LICENSE-* $td/$devver/book/$lang/
           done
@@ -569,7 +574,9 @@ jobs:
               cp -r target/doc $td/$prefix/api
               sed 's|URL|rtic/index.html|g' $root/redirect.html > $td/$prefix/api/index.html
               for lang in ${langs[@]}; do
-                  ( cd book/$lang && mdbook build )
+                  ( cd book/$lang &&
+                    if mdbook build |& tee /dev/tty | grep "\[ERROR\]"; then exit 1; else exit 0; fi
+                  )
                   cp -r book/$lang/book $td/$prefix/book/$lang
                   cp LICENSE-* $td/$prefix/book/$lang/
               done

CHANGELOG.md

@@ -14,6 +14,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+- Force mdBook to return error codes
 - Readded missing ramfunc output to book
 
 ## [v1.0.0] - 2021-12-25

book/ru/src/by-example/tips.md

@@ -83,12 +83,12 @@ $ cargo run --example ramfunc
 
 ``` console
 $ cargo nm --example ramfunc --release | grep ' foo::'
-{{#include ../../../../ci/expected/ramfunc.grep.foo}}
+{{#include ../../../../ci/expected/ramfunc.run.grep.foo}}
 ```
 
 ``` console
 $ cargo nm --example ramfunc --release | grep ' bar::'
-{{#include ../../../../ci/expected/ramfunc.grep.bar}}
+{{#include ../../../../ci/expected/ramfunc.run.grep.bar}}
 ```
 
 ## Обходной путь для быстрой передачи сообщений