Skip to content

ci: gate cargo doc warnings + fix broken intra-doc links (COW-1069) #28

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.

Sign up for GitHub

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

Open
brunota20 wants to merge 1 commit into
base: feat/ci-build-all-modules-cow-1066
Choose a base branch
from
Open

ci: gate cargo doc warnings + fix broken intra-doc links (COW-1069) #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,20 @@ jobs:
- uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1
- run: cargo test --workspace --all-features --no-fail-fast

docs:
name: rustdoc
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: "-D warnings"
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: dtolnay/rust-toolchain@3c5f7ea28cd621ae0bf5283f0e981fb97b8a7af9 # master 2026-03-27
with:
toolchain: nightly
targets: wasm32-wasip2
- uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1
- run: cargo doc --workspace --no-deps

build-module:
name: build ${{ matrix.module }} (wasm32-wasip2)
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion crates/nexum-engine/src/bindings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
//! natively - no vendored `deps/` tree needed. The world name is fully
//! qualified.
//!
//! Every `Host` trait impl in [`crate::host::impls`] consumes types
//! Every `Host` trait impl in `crate::host::impls` consumes types
//! generated here.

wasmtime::component::bindgen!({
Expand Down
2 changes: 1 addition & 1 deletion crates/nexum-engine/src/manifest/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
//!
//! - [`types`]: the serde `Manifest` shape + `LoadedManifest` the engine
//! actually consumes, plus the `KNOWN_CAPABILITIES` registry.
//! - [`load`]: `module.toml` -> `LoadedManifest`, plus the host/URL
//! - [`mod@load`]: `module.toml` -> `LoadedManifest`, plus the host/URL
//! helpers the `http` backend uses at request time.
//! - [`capabilities`]: WIT-import vs declared-capabilities cross-check.
//! - [`error`]: `ParseError`, `CapabilityViolation`.
Expand Down
2 changes: 1 addition & 1 deletion crates/nexum-engine/src/manifest/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Data structures: `Manifest`, sections, and `LoadedManifest`.
//!
//! Plain serde shapes plus the `KNOWN_CAPABILITIES` registry. The parsing
//! and validation logic lives in [`super::load`]; capability enforcement
//! and validation logic lives in [`mod@super::load`]; capability enforcement
//! in [`super::capabilities`].

use serde::Deserialize;
Expand Down