added xtask bin for tests (#715, #712) #717
Conversation
…ery#712 (maybe?) - reworked book operations in xtask - updated readme for new build command - updated contribution.md for new test commands - fixed missing dictionary - added contributor tests to xtask (`cargo test`, `mdbook serve -o`, `./ci/spellcheck.sh`, `link-checker ./book` (moved to Lychee)) - updated ci .sh files for the new cookbook dir - fixed broken link
README.md
Outdated
| @@ -20,7 +20,7 @@ If you'd like to read it locally: | |||
| $ git clone https://github.com/rust-lang-nursery/rust-cookbook | |||
| $ cd rust-cookbook | |||
| $ cargo install mdbook --vers "0.4.43" | |||
| $ mdbook serve --open | |||
| $ cargo xtask book build | |||
There was a problem hiding this comment.
I think both of these things should be highlighted in the readme, but this included note should have its own section rather than clobbering the mdbook serve --open operation.
There was a problem hiding this comment.
sure I'll revert the changes and create a separate readme
There was a problem hiding this comment.
is there a reason why the version of the mdbook in the contribution guidelines is different from the readme?
There was a problem hiding this comment.
Thanks for highlighting the contributions guideline's need to be updated.
- added version check for mdbook
- fixed broken link (clients.md/rust-lang-nursery#572 (comment))
|
For #572, the link problem at (https://rust-lang-nursery.github.io/rust-cookbook/web/clients.html) is now fixed But the mdbook-linkcheck configuration in book.toml would require people to install mdbook-linkcheck to build the project It also triggers false positives and does not catch some broken links, I think lychee is a better option as it's easier to use and catches errors after site build |
I'm receptive to it. You wouldn't happen to know how to get that set up would you? |
|
It's already included in xtask you can run it via Or additional instructions in the cotribution.md? |
|
My fault for the unclear message. Thank you for including it and then following up with a good justification. |
fixes #715 fixes #712
cargo test,mdbook serve -o,./ci/spellcheck.sh,link-checker ./book(moved to Lychee))created xtask single bin and alias instead of a workspace to prevent breaking ci or other stuff
does this fix #712 ?
are the changes form #715 fine?