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

Automate more checks #712

Open
joshka opened this issue Dec 1, 2024 · 2 comments · May be fixed by #717
Open

Automate more checks #712

joshka opened this issue Dec 1, 2024 · 2 comments · May be fixed by #717
Labels

Comments

@joshka
Copy link

joshka commented Dec 1, 2024

The list of checkboxes of things to manually run to check a PR is prohibitively large, which is a barrier to contribution.
Ideally a single run "cargo xtask check" or something similar should be provided that does all the checks.

@AndyGauge AndyGauge added the 2024 label Dec 2, 2024
@AndyGauge
Copy link
Collaborator

That would make it super easy to contribute to, which is the direction we want to head.

@Arteiii
Copy link
Contributor

Arteiii commented Dec 13, 2024

Well, move the current source files to a new dir (cookbook/) and create the xtask and .cargo dir along with a root Cargo.toml for the workspace.

would probably make it easier to run the book build/serve and test?

I have tried this and the current structure looks like this, LMK if this approach is fine for you.

├── .cargo
│   ├── config.toml
├── ci
├── cookbook
│   ├── assets
│   ├── src
│   ├── tests
│   ├── theme
│   ├── book.toml
│   ├── build.rs
│   ├── Cargo.toml
├── xtask
│   ├── src
│   ├── Cargo.toml
│   ├── Cargo.lock
├── appveyor.yml
├── travis.yml
├── Cargo.toml (workspace file)

Arteiii added a commit to Arteiii/rust-cookbook that referenced this issue Dec 16, 2024
…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
@Arteiii Arteiii linked a pull request Dec 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants