Skip to content

Commit bf4c648

Browse files
ramfox“ramfox”
andauthored
chore: add CI to ensure docs-rs publishing will work (#360)
Also, removes "log" from list of features for `iroh-quinn-proto` to run with `docs-rs`, since it is not a feature `iroh-quinn-proto` has Co-authored-by: “ramfox” <“kasey@n0.computer”>
1 parent e424c7f commit bf4c648

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

.github/workflows/ci.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,17 +225,20 @@ jobs:
225225
env:
226226
RUSTC_WRAPPER: "sccache"
227227
SCCACHE_GHA_ENABLED: "on"
228-
RUSTDOCFLAGS: --cfg docsrs
228+
RUSTDOCFLAGS: -Dwarnings
229229
steps:
230230
- uses: actions/checkout@v6
231-
- uses: dtolnay/rust-toolchain@master
232-
with:
233-
toolchain: nightly-2025-10-09
231+
- uses: dtolnay/rust-toolchain@nightly
232+
- uses: dtolnay/install@cargo-docs-rs
234233
- name: Install sccache
235234
uses: mozilla-actions/sccache-action@v0.0.9
236235

237-
- name: Docs
238-
run: cargo doc --workspace --all-features --no-deps --document-private-items
236+
- name: quinn docs
237+
run: cargo docs-rs -p iroh-quinn
238+
- name: quinn-proto docs
239+
run: cargo docs-rs -p iroh-quinn-proto
240+
- name: quinn-udp docs
241+
run: cargo docs-rs -p iroh-quinn-udp
239242

240243
clippy_check:
241244
timeout-minutes: 30

quinn-proto/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,4 @@ workspace = true
9393

9494
[package.metadata.docs.rs]
9595
# all non-default features except fips (cannot build on docs.rs environment)
96-
features = ["rustls-aws-lc-rs", "rustls-ring", "platform-verifier", "log", "rustls-log"]
96+
features = ["aws-lc-rs", "rustls-aws-lc-rs", "rustls-ring", "platform-verifier", "rustls-log", "qlog", "bench"]

quinn-proto/src/endpoint.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1232,8 +1232,6 @@ pub struct Incoming {
12321232

12331233
impl Incoming {
12341234
/// The local IP address which was used when the peer established the connection
1235-
///
1236-
/// This has the same behavior as [`Connection::local_ip`].
12371235
pub fn local_ip(&self) -> Option<IpAddr> {
12381236
self.network_path.local_ip
12391237
}

0 commit comments

Comments
 (0)