Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added xtask bin for tests (#715, #712) #717

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Arteiii
Copy link
Contributor

@Arteiii Arteiii commented Dec 16, 2024

fixes #715 fixes #712

  • 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))
  • fixed broken link

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?

…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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure I'll revert the changes and create a separate readme

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a reason why the version of the mdbook in the contribution guidelines is different from the readme?

- added version check for mdbook
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Switch Link Checker to Lychee (Rust) Automate more checks
2 participants