mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-27 14:04:56 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge #604

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



Co-authored-by: Henrik Tjäder <henrik@grepit.se>
This commit is contained in:
bors[bot] 2022-02-09 17:33:19 +00:00 committed by GitHub
commit 1464898291
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
.github/workflows/build.yml vendored
View file

@ -458,10 +458,12 @@ jobs:
mdbook-version: 'latest' mdbook-version: 'latest'
- name: Build book in English - 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 - 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 - name: Check links
run: | run: |
@ -518,6 +520,7 @@ jobs:
run: cargo doc run: cargo doc
- name: Build books - name: Build books
shell: 'script --return --quiet --command "bash {0}"'
run: | run: |
langs=( en ru ) langs=( en ru )
devver=( dev ) devver=( dev )
@ -549,7 +552,9 @@ jobs:
# Build books # Build books
for lang in ${langs[@]}; do 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 -r book/$lang/book $td/$devver/book/$lang
cp LICENSE-* $td/$devver/book/$lang/ cp LICENSE-* $td/$devver/book/$lang/
done done
@ -569,7 +574,9 @@ jobs:
cp -r target/doc $td/$prefix/api cp -r target/doc $td/$prefix/api
sed 's|URL|rtic/index.html|g' $root/redirect.html > $td/$prefix/api/index.html sed 's|URL|rtic/index.html|g' $root/redirect.html > $td/$prefix/api/index.html
for lang in ${langs[@]}; do 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 -r book/$lang/book $td/$prefix/book/$lang
cp LICENSE-* $td/$prefix/book/$lang/ cp LICENSE-* $td/$prefix/book/$lang/
done done

1
CHANGELOG.md
View file

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

4
book/ru/src/by-example/tips.md
View file

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