CI: run cargo doc #879
CI: run cargo doc #879
Conversation
alyssais
requested review from
stsquad,
vireshk,
stefano-garzarella and
epilys
as code owners
| "test_name": "style", | ||
| "command": "cargo fmt --all -- --check --config format_code_in_doc_comments=true" | ||
| }, | ||
| { |
There was a problem hiding this comment.
LGTM, but I'd add the same also in for staging crates (.buildkite/staging-tests.json)
|
@roypat @epilys @RuoqingHe do you think we should add something similar also in https://github.com/rust-vmm/rust-vmm-ci/blob/main/.buildkite/test_description.json ? |
Yes, I think we should. crates.io automatically publishes our documentation to docs.rs, and if cargo doc doesnt work, that might limit discoverability of our crates |
|
Should I keep going with this PR, or is the idea that it'll be entirely handled in rust-vmm-ci? |
|
@alyssais unfortunately here in |
Link: rust-vmm#877 (comment) Signed-off-by: Alyssa Ross <[email protected]>
|
Ah, I guess I actually need to fix the staging devices first! |
Summary of the PR
Link: #877 (comment)
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commit message has max 60 characters for thesummary and max 75 characters for each description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.