cleanup crate docs #458

TroyKomodo · 2025-05-13T22:59:02Z

Adds a few cool tricks I found with crate docs

crates/aac/src/lib.rs

cloudflare-workers-and-pages · 2025-05-13T23:02:54Z

Deploying scuffle-docusaurus-docs with Cloudflare Pages

Latest commit:	`5041ea5`
Status:	✅ Deploy successful!
Preview URL:	https://57738513.scuffle-docusaurus-docs.pages.dev
Branch Preview URL:	https://pr-458.scuffle-docusaurus-docs.pages.dev

View logs

github-actions · 2025-05-13T23:03:41Z

🛫 Startup details 🛫

Revision main not found locally. Fetching from origin...

Checking out commit 69a08df into "target/semver-baseline"

HEAD is now at 69a08df Auto merge of #456 - troy/patches, r=philipch07

📦 Processing crates 📦

nutype-enum
openapiv3_1
postcompile
scuffle-aac
scuffle-amf0
scuffle-av1
scuffle-batching
scuffle-bootstrap
scuffle-bootstrap-telemetry
scuffle-bytes-util
scuffle-context
scuffle-expgolomb
scuffle-ffmpeg
scuffle-flv
scuffle-future-ext
scuffle-h264
scuffle-h265
scuffle-http
scuffle-metrics
scuffle-mp4
scuffle-pprof
scuffle-rtmp
scuffle-settings
scuffle-signal
scuffle-transmuxer
scuffle-workspace-hack
tinc
tinc-build
tinc-cel
tinc-derive
tinc-pb-prost

Original semver output:

Building nutype-enum v0.1.4 (current)
   Built [   3.506s] (current)
 Parsing nutype-enum v0.1.4 (current)
  Parsed [   0.004s] (current)
Building nutype-enum v0.1.3 (baseline)
   Built [   0.550s] (baseline)
 Parsing nutype-enum v0.1.3 (baseline)
  Parsed [   0.004s] (baseline)
Checking nutype-enum v0.1.3 -> v0.1.4 (minor change)
 Checked [   0.108s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   5.236s] nutype-enum
Building openapiv3_1 v0.1.1 (current)
   Built [   6.969s] (current)
 Parsing openapiv3_1 v0.1.1 (current)
  Parsed [   0.083s] (current)
Building openapiv3_1 v0.1.0 (baseline)
   Built [   6.532s] (baseline)
 Parsing openapiv3_1 v0.1.0 (baseline)
  Parsed [   0.070s] (baseline)
Checking openapiv3_1 v0.1.0 -> v0.1.1 (minor change)
 Checked [   2.255s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  18.148s] openapiv3_1
Building postcompile v0.3.0 (current)
   Built [   6.748s] (current)
 Parsing postcompile v0.3.0 (current)
  Parsed [   0.009s] (current)
Building postcompile v0.2.0 (baseline)
   Built [   5.712s] (baseline)
 Parsing postcompile v0.2.0 (baseline)
  Parsed [   0.009s] (baseline)
Checking postcompile v0.2.0 -> v0.3.0 (major change)
 Checked [   0.000s] 0 checks: 0 pass, 164 skip
 Summary no semver update required
Finished [  13.631s] postcompile
Building scuffle-aac v0.1.3 (current)
   Built [   3.101s] (current)
 Parsing scuffle-aac v0.1.3 (current)
  Parsed [   0.006s] (current)
Building scuffle-aac v0.1.2 (baseline)
   Built [   2.432s] (baseline)
 Parsing scuffle-aac v0.1.2 (baseline)
  Parsed [   0.006s] (baseline)
Checking scuffle-aac v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.135s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   6.819s] scuffle-aac
Building scuffle-amf0 v0.2.1 (current)
   Built [   3.358s] (current)
 Parsing scuffle-amf0 v0.2.1 (current)
  Parsed [   0.013s] (current)
Building scuffle-amf0 v0.2.0 (baseline)
   Built [   2.476s] (baseline)
 Parsing scuffle-amf0 v0.2.0 (baseline)
  Parsed [   0.005s] (baseline)
Checking scuffle-amf0 v0.2.0 -> v0.2.1 (minor change)
 Checked [   0.252s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   6.565s] scuffle-amf0
Building scuffle-av1 v0.1.3 (current)
   Built [   3.042s] (current)
 Parsing scuffle-av1 v0.1.3 (current)
  Parsed [   0.009s] (current)
Building scuffle-av1 v0.1.2 (baseline)
   Built [   0.761s] (baseline)
 Parsing scuffle-av1 v0.1.2 (baseline)
  Parsed [   0.009s] (baseline)
Checking scuffle-av1 v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.194s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   4.463s] scuffle-av1
Building scuffle-batching v0.1.3 (current)
   Built [   3.184s] (current)
 Parsing scuffle-batching v0.1.3 (current)
  Parsed [   0.008s] (current)
Building scuffle-batching v0.1.2 (baseline)
   Built [   1.265s] (baseline)
 Parsing scuffle-batching v0.1.2 (baseline)
  Parsed [   0.008s] (baseline)
Checking scuffle-batching v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.167s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   5.147s] scuffle-batching
Building scuffle-bootstrap v0.1.3 (current)
   Built [   5.116s] (current)
 Parsing scuffle-bootstrap v0.1.3 (current)
  Parsed [   0.004s] (current)
Building scuffle-bootstrap v0.1.2 (baseline)
   Built [   5.241s] (baseline)
 Parsing scuffle-bootstrap v0.1.2 (baseline)
  Parsed [   0.009s] (baseline)
Checking scuffle-bootstrap v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.134s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  11.955s] scuffle-bootstrap
Building scuffle-bootstrap-telemetry v0.2.2 (current)
   Built [   8.429s] (current)
 Parsing scuffle-bootstrap-telemetry v0.2.2 (current)
  Parsed [   0.014s] (current)
Building scuffle-bootstrap-telemetry v0.2.1 (baseline)
   Built [   8.782s] (baseline)
 Parsing scuffle-bootstrap-telemetry v0.2.1 (baseline)
  Parsed [   0.006s] (baseline)
Checking scuffle-bootstrap-telemetry v0.2.1 -> v0.2.2 (minor change)
 Checked [   0.117s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  19.318s] scuffle-bootstrap-telemetry
Building scuffle-bytes-util v0.1.3 (current)
   Built [   3.198s] (current)
 Parsing scuffle-bytes-util v0.1.3 (current)
  Parsed [   0.006s] (current)
Building scuffle-bytes-util v0.1.2 (baseline)
   Built [   1.963s] (baseline)
 Parsing scuffle-bytes-util v0.1.2 (baseline)
  Parsed [   0.010s] (baseline)
Checking scuffle-bytes-util v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.174s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   6.405s] scuffle-bytes-util
Building scuffle-context v0.1.3 (current)
   Built [   3.092s] (current)
 Parsing scuffle-context v0.1.3 (current)
  Parsed [   0.008s] (current)
Building scuffle-context v0.1.2 (baseline)
   Built [   1.062s] (baseline)
 Parsing scuffle-context v0.1.2 (baseline)
  Parsed [   0.008s] (baseline)
Checking scuffle-context v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.146s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   5.001s] scuffle-context
Building scuffle-expgolomb v0.1.3 (current)
   Built [   3.219s] (current)
 Parsing scuffle-expgolomb v0.1.3 (current)
  Parsed [   0.004s] (current)
Building scuffle-expgolomb v0.1.2 (baseline)
   Built [   0.840s] (baseline)
 Parsing scuffle-expgolomb v0.1.2 (baseline)
  Parsed [   0.004s] (baseline)
Checking scuffle-expgolomb v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.105s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   4.673s] scuffle-expgolomb
Building scuffle-ffmpeg v0.3.1 (current)
   Built [  10.254s] (current)
 Parsing scuffle-ffmpeg v0.3.1 (current)
  Parsed [   0.057s] (current)
Building scuffle-ffmpeg v0.3.0 (baseline)
   Built [   9.256s] (baseline)
 Parsing scuffle-ffmpeg v0.3.0 (baseline)
  Parsed [   0.060s] (baseline)
Checking scuffle-ffmpeg v0.3.0 -> v0.3.1 (minor change)
 Checked [   1.716s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  22.889s] scuffle-ffmpeg
Building scuffle-flv v0.2.1 (current)
   Built [   4.126s] (current)
 Parsing scuffle-flv v0.2.1 (current)
  Parsed [   0.028s] (current)
Building scuffle-flv v0.2.0 (baseline)
   Built [   4.546s] (baseline)
 Parsing scuffle-flv v0.2.0 (baseline)
  Parsed [   0.018s] (baseline)
Checking scuffle-flv v0.2.0 -> v0.2.1 (minor change)
 Checked [   0.648s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  10.668s] scuffle-flv
Building scuffle-future-ext v0.1.3 (current)
   Built [   3.503s] (current)
 Parsing scuffle-future-ext v0.1.3 (current)
  Parsed [   0.002s] (current)
Building scuffle-future-ext v0.1.2 (baseline)
   Built [   0.636s] (baseline)
 Parsing scuffle-future-ext v0.1.2 (baseline)
  Parsed [   0.005s] (baseline)
Checking scuffle-future-ext v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.096s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [   4.771s] scuffle-future-ext
Building scuffle-h264 v0.2.1 (current)
   Built [   3.533s] (current)
 Parsing scuffle-h264 v0.2.1 (current)
  Parsed [   0.005s] (current)
Building scuffle-h264 v0.2.0 (baseline)

error: running cargo-doc on crate 'scuffle-h264' failed with output:

Compiling scuffle-workspace-hack v0.1.0
Checking bytes v1.10.1
Checking byteorder v1.5.0
Checking nutype-enum v0.1.3
Checking bytestring v1.4.0
Checking scuffle-bytes-util v0.1.2
Checking scuffle-expgolomb v0.1.2
Documenting scuffle-h264 v0.2.0 (/home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h264)
error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h264/src/sps/chroma_sample_loc.rs:3:48
|
3 | use scuffle_bytes_util::{BitReader, BitWriter, range_check};
| ^^^^^^^^^^^ no range_check in the root

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h264/src/sps/pic_order_count_type1.rs:3:48
|
3 | use scuffle_bytes_util::{BitReader, BitWriter, range_check};
| ^^^^^^^^^^^ no range_check in the root

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h264/src/sps/sps_ext.rs:3:48
|
3 | use scuffle_bytes_util::{BitReader, BitWriter, range_check};
| ^^^^^^^^^^^ no range_check in the root

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h264/src/sps/mod.rs:23:71
|
23 | use scuffle_bytes_util::{BitReader, BitWriter, EmulationPreventionIo, range_check};
| ^^^^^^^^^^^ no range_check in the root

For more information about this error, try rustc --explain E0432.
error: could not document scuffle-h264

error: failed to build rustdoc for crate scuffle-h264 v0.2.0
note: this is usually due to a compilation error in the crate,
and is unlikely to be a bug in cargo-semver-checks
note: the following command can be used to reproduce the compilation error:
cargo new --lib example &&
cd example &&
echo '[workspace]' >> Cargo.toml &&
cargo add --path target/semver-baseline/crates/h264 &&
cargo check

Building scuffle-h265 v0.2.1 (current)
   Built [   3.154s] (current)
 Parsing scuffle-h265 v0.2.1 (current)
  Parsed [   0.020s] (current)
Building scuffle-h265 v0.2.0 (baseline)

error: running cargo-doc on crate 'scuffle-h265' failed with output:

Compiling scuffle-workspace-hack v0.1.0
Checking bytes v1.10.1
Checking byteorder v1.5.0
Checking bitflags v2.9.1
Checking nutype-enum v0.1.3
Checking bytestring v1.4.0
Checking scuffle-bytes-util v0.1.2
Checking scuffle-expgolomb v0.1.2
Documenting scuffle-h265 v0.2.0 (/home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265)
error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/nal_unit_header.rs:4:37
|
4 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/mod.rs:4:60
|
4 | use scuffle_bytes_util::{BitReader, EmulationPreventionIo, range_check};
| ^^^^^^^^^^^ no range_check in the root

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/long_term_ref_pics.rs:3:37
|
3 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/pcm.rs:3:37
|
3 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/profile_tier_level.rs:4:37
|
4 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/sps_3d_extension.rs:3:37
|
3 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/sps_scc_extension.rs:3:37
|
3 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/st_ref_pic_set.rs:4:37
|
4 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/sub_layer_ordering_info.rs:3:37
|
3 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/vui_parameters/mod.rs:5:37
|
5 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

error[E0432]: unresolved import scuffle_bytes_util::range_check
--> /home/runner/work/scuffle/scuffle/target/semver-baseline/crates/h265/src/sps/vui_parameters/hrd_parameters.rs:4:37
|
4 | use scuffle_bytes_util::{BitReader, range_check};
| ^^^^^^^^^^^ no range_check in the root
|
= help: consider importing this unresolved item through its public re-export instead:
crate::sps::range_check

For more information about this error, try rustc --explain E0432.
error: could not document scuffle-h265

error: failed to build rustdoc for crate scuffle-h265 v0.2.0
note: this is usually due to a compilation error in the crate,
and is unlikely to be a bug in cargo-semver-checks
note: the following command can be used to reproduce the compilation error:
cargo new --lib example &&
cd example &&
echo '[workspace]' >> Cargo.toml &&
cargo add --path target/semver-baseline/crates/h265 &&
cargo check

Building scuffle-http v0.3.0 (current)
   Built [  17.355s] (current)
 Parsing scuffle-http v0.3.0 (current)
  Parsed [   0.026s] (current)
Building scuffle-http v0.2.1 (baseline)
   Built [  14.716s] (baseline)
 Parsing scuffle-http v0.2.1 (baseline)
  Parsed [   0.039s] (baseline)
Checking scuffle-http v0.2.1 -> v0.3.0 (major change)
 Checked [   0.000s] 0 checks: 0 pass, 164 skip
 Summary no semver update required
Finished [  34.055s] scuffle-http
Building scuffle-metrics v0.3.0 (current)
   Built [   4.963s] (current)
 Parsing scuffle-metrics v0.3.0 (current)
  Parsed [   0.012s] (current)
Building scuffle-metrics v0.2.0 (baseline)
   Built [   4.784s] (baseline)
 Parsing scuffle-metrics v0.2.0 (baseline)
  Parsed [   0.012s] (baseline)
Checking scuffle-metrics v0.2.0 -> v0.3.0 (major change)
 Checked [   0.000s] 0 checks: 0 pass, 164 skip
 Summary no semver update required
Finished [  11.531s] scuffle-metrics
Building scuffle-mp4 v0.1.3 (current)
   Built [   5.463s] (current)
 Parsing scuffle-mp4 v0.1.3 (current)
  Parsed [   0.058s] (current)
Building scuffle-mp4 v0.1.2 (baseline)
   Built [   5.255s] (baseline)
 Parsing scuffle-mp4 v0.1.2 (baseline)
  Parsed [   0.026s] (baseline)
Checking scuffle-mp4 v0.1.2 -> v0.1.3 (minor change)
 Checked [   1.505s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  12.957s] scuffle-mp4
Building scuffle-pprof v0.1.3 (current)
   Built [   6.738s] (current)
 Parsing scuffle-pprof v0.1.3 (current)
  Parsed [   0.004s] (current)
Building scuffle-pprof v0.1.2 (baseline)
   Built [   6.619s] (baseline)
 Parsing scuffle-pprof v0.1.2 (baseline)
  Parsed [   0.004s] (baseline)
Checking scuffle-pprof v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.105s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  14.307s] scuffle-pprof
Building scuffle-rtmp v0.2.1 (current)
   Built [   5.334s] (current)
 Parsing scuffle-rtmp v0.2.1 (current)
  Parsed [   0.037s] (current)
Building scuffle-rtmp v0.2.0 (baseline)
   Built [   4.569s] (baseline)
 Parsing scuffle-rtmp v0.2.0 (baseline)
  Parsed [   0.036s] (baseline)
Checking scuffle-rtmp v0.2.0 -> v0.2.1 (minor change)
 Checked [   0.613s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  12.136s] scuffle-rtmp
Building scuffle-settings v0.1.3 (current)
   Built [   6.869s] (current)
 Parsing scuffle-settings v0.1.3 (current)
  Parsed [   0.007s] (current)
Building scuffle-settings v0.1.2 (baseline)
   Built [   7.468s] (baseline)
 Parsing scuffle-settings v0.1.2 (baseline)
  Parsed [   0.008s] (baseline)
Checking scuffle-settings v0.1.2 -> v0.1.3 (minor change)
 Checked [   0.118s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  16.095s] scuffle-settings
Building scuffle-signal v0.3.1 (current)
   Built [   5.746s] (current)
 Parsing scuffle-signal v0.3.1 (current)
  Parsed [   0.004s] (current)
Building scuffle-signal v0.3.0 (baseline)
   Built [   5.284s] (baseline)
 Parsing scuffle-signal v0.3.0 (baseline)
  Parsed [   0.006s] (baseline)
Checking scuffle-signal v0.3.0 -> v0.3.1 (minor change)
 Checked [   0.117s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  11.868s] scuffle-signal
Building scuffle-transmuxer v0.2.1 (current)
   Built [   5.627s] (current)
 Parsing scuffle-transmuxer v0.2.1 (current)
  Parsed [   0.014s] (current)
Building scuffle-transmuxer v0.2.0 (baseline)
   Built [   5.730s] (baseline)
 Parsing scuffle-transmuxer v0.2.0 (baseline)
  Parsed [   0.015s] (baseline)
Checking scuffle-transmuxer v0.2.0 -> v0.2.1 (minor change)
 Checked [   0.214s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  12.744s] scuffle-transmuxer
Building scuffle-workspace-hack v0.1.0 (current)
   Built [   0.597s] (current)
 Parsing scuffle-workspace-hack v0.1.0 (current)
  Parsed [   0.004s] (current)
Building scuffle-workspace-hack v0.1.0 (baseline)
   Built [  29.699s] (baseline)
 Parsing scuffle-workspace-hack v0.1.0 (baseline)
  Parsed [   0.010s] (baseline)
Checking scuffle-workspace-hack v0.1.0 -> v0.1.0 (no change)
 Checked [   0.115s] 153 checks: 153 pass, 11 skip
 Summary no semver update required
Finished [  31.480s] scuffle-workspace-hack
Building tinc v0.1.1 (current)
   Built [  12.386s] (current)
 Parsing tinc v0.1.1 (current)
  Parsed [   0.040s] (current)
Building tinc v0.1.0 (baseline)
   Built [  11.811s] (baseline)
 Parsing tinc v0.1.0 (baseline)
  Parsed [   0.040s] (baseline)
Checking tinc v0.1.0 -> v0.1.1 (minor change)
 Checked [   0.295s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  26.877s] tinc
Building tinc-build v0.1.1 (current)
   Built [  11.430s] (current)
 Parsing tinc-build v0.1.1 (current)
  Parsed [   0.028s] (current)
Building tinc-build v0.1.0 (baseline)
   Built [  11.213s] (baseline)
 Parsing tinc-build v0.1.0 (baseline)
  Parsed [   0.041s] (baseline)
Checking tinc-build v0.1.0 -> v0.1.1 (minor change)
 Checked [   0.345s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  26.099s] tinc-build
Building tinc-cel v0.0.2 (current)
   Built [   5.895s] (current)
 Parsing tinc-cel v0.0.2 (current)
  Parsed [   0.014s] (current)
Building tinc-cel v0.0.1 (baseline)
   Built [   4.564s] (baseline)
 Parsing tinc-cel v0.0.1 (baseline)
  Parsed [   0.015s] (baseline)
Checking tinc-cel v0.0.1 -> v0.0.2 (major change)
 Checked [   0.000s] 0 checks: 0 pass, 164 skip
 Summary no semver update required
Finished [  11.945s] tinc-cel
Building tinc-pb-prost v0.1.1 (current)
   Built [   5.437s] (current)
 Parsing tinc-pb-prost v0.1.1 (current)
  Parsed [   0.028s] (current)
Building tinc-pb-prost v0.1.0 (baseline)
   Built [   5.262s] (baseline)
 Parsing tinc-pb-prost v0.1.0 (baseline)
  Parsed [   0.029s] (baseline)
Checking tinc-pb-prost v0.1.0 -> v0.1.1 (minor change)
 Checked [   0.635s] 128 checks: 128 pass, 36 skip
 Summary no semver update required
Finished [  12.680s] tinc-pb-prost

error: aborting due to failure to build rustdoc for crate scuffle-h264 v0.2.0

Semver-checks summary

✅ No semver violations found! ✅

🛬 Cleanup details 🛬

Cleaning up git worktree at "target/semver-baseline"

Successfully removed git worktree

cloudflare-workers-and-pages · 2025-05-13T23:04:01Z

Deploying scuffle-docrs with Cloudflare Pages

Latest commit:	`5041ea5`
Status:	✅ Deploy successful!
Preview URL:	https://ad8780c3.scuffle-docrs.pages.dev
Branch Preview URL:	https://pr-458.scuffle-docrs.pages.dev

View logs

codecov · 2025-05-13T23:06:09Z

Codecov Report

Attention: Patch coverage is 80.68182% with 17 lines in your changes missing coverage. Please review.

Project coverage is 78.97%. Comparing base (69a08df) to head (5041ea5).
Report is 8 commits behind head on main.

❗ Current head 5041ea5 differs from pull request most recent head d3a7c0e

Please upload reports for the commit d3a7c0e to get more accurate results.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
crates/changelog/src/macro_impl.rs	88.15%	9 Missing ⚠️
crates/metrics/src/prometheus/mod.rs	0.00%	7 Missing ⚠️
crates/changelog/src/lib.rs	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #458      +/-   ##
==========================================
+ Coverage   78.95%   78.97%   +0.01%     
==========================================
  Files         323      325       +2     
  Lines       24266    24306      +40     
==========================================
+ Hits        19159    19195      +36     
- Misses       5107     5111       +4

Files with missing lines	Coverage Δ
crates/aac/src/lib.rs	`89.47% <ø> (ø)`
crates/amf0/src/decoder.rs	`93.45% <ø> (ø)`
crates/amf0/src/encoder.rs	`94.36% <ø> (ø)`
crates/amf0/src/error.rs	`50.00% <ø> (ø)`
crates/amf0/src/value.rs	`93.05% <ø> (ø)`
crates/bootstrap/derive/src/lib.rs	`87.50% <ø> (ø)`
crates/bootstrap/src/config.rs	`100.00% <ø> (ø)`
crates/bootstrap/src/lib.rs	`0.00% <ø> (ø)`
crates/bootstrap/src/service.rs	`100.00% <ø> (ø)`
crates/bootstrap/telemetry/src/lib.rs	`73.24% <ø> (ø)`
... and 30 more

... and 1 file with indirect coverage changes

Components	Coverage Δ
scuffle-aac	`89.47% <ø> (ø)`
scuffle-amf0	`90.31% <ø> (ø)`
scuffle-av1	`98.40% <ø> (ø)`
scuffle-batching	`100.00% <ø> (ø)`
scuffle-bootstrap	`82.79% <ø> (ø)`
scuffle-bytes-util	`96.70% <ø> (ø)`
scuffle-context	`100.00% <ø> (ø)`
scuffle-expgolomb	`100.00% <ø> (ø)`
scuffle-ffmpeg	`90.01% <ø> (-0.13%)`	⬇️
scuffle-flv	`95.59% <ø> (ø)`
scuffle-future-ext	`50.00% <ø> (ø)`
nutype-enum	`71.87% <ø> (ø)`
scuffle-h264	`99.68% <ø> (ø)`
scuffle-http	`85.36% <ø> (ø)`
scuffle-metrics	`87.29% <0.00%> (-0.67%)`	⬇️
postcompile	`81.52% <ø> (ø)`
scuffle-pprof	`100.00% <ø> (ø)`
scuffle-rtmp	`90.88% <ø> (-0.28%)`	⬇️
scuffle-settings	`93.44% <ø> (ø)`
scuffle-signal	`95.41% <ø> (+9.60%)`	⬆️

crates/bootstrap/telemetry/src/lib.rs

crates/metrics/derive/src/lib.rs

crates/metrics/src/lib.rs

crates/settings/src/lib.rs

crates/tinc/src/lib.rs

TroyKomodo · 2025-05-14T04:10:27Z

?brawl merge

scuffle-brawl · 2025-05-14T04:10:30Z

📌 Commit 0d562c5 has been approved and added to the merge queue.

Requested by: @TroyKomodo

Approved by: @philipch07

cleanup crate docs Adds a few cool tricks I found with crate docs Requested-by: TroyKomodo <49777269+TroyKomodo@users.noreply.github.com> Reviewed-by: philipch07 <59272129+philipch07@users.noreply.github.com>

scuffle-brawl · 2025-05-14T04:10:36Z

⌛ Trying commit 0d562c5 with merge 5bd96b9...

scuffle-brawl · 2025-05-14T04:11:52Z

💔 Test failed - brawl-done

TroyKomodo · 2025-05-14T04:25:57Z

?brawl merge

scuffle-brawl · 2025-05-14T04:25:59Z

📌 Commit 37df758 has been approved and added to the merge queue.

Requested by: @TroyKomodo

Approved by: @philipch07

scuffle-brawl · 2025-05-14T04:26:08Z

⌛ Trying commit 37df758 with merge 6f5e183...

cleanup crate docs Adds a few cool tricks I found with crate docs Requested-by: TroyKomodo <49777269+TroyKomodo@users.noreply.github.com> Reviewed-by: philipch07 <59272129+philipch07@users.noreply.github.com>

scuffle-brawl · 2025-05-14T21:36:59Z

💔 Test failed - brawl-done

TroyKomodo · 2025-05-15T04:42:01Z

?brawl merge

scuffle-brawl · 2025-05-15T04:42:04Z

📌 Commit 5041ea5 has been approved and added to the merge queue.

Requested by: @TroyKomodo

Approved by: @lennartkloock @philipch07

scuffle-brawl · 2025-05-15T04:42:25Z

⌛ Trying commit 5041ea5 with merge 09d37b9...

cleanup crate docs Adds a few cool tricks I found with crate docs Requested-by: TroyKomodo <49777269+TroyKomodo@users.noreply.github.com> Reviewed-by: lennartkloock <39778085+lennartkloock@users.noreply.github.com> Reviewed-by: philipch07 <59272129+philipch07@users.noreply.github.com>

scuffle-brawl · 2025-05-15T04:49:44Z

💔 Test failed - brawl-done

TroyKomodo · 2025-05-15T04:52:11Z

?brawl merge

scuffle-brawl · 2025-05-15T04:52:14Z

📌 Commit d3a7c0e has been approved and added to the merge queue.

Requested by: @TroyKomodo

Approved by: @lennartkloock @philipch07

scuffle-brawl · 2025-05-15T04:52:27Z

⌛ Trying commit d3a7c0e with merge 9f7fb80...

scuffle-brawl · 2025-05-15T05:11:49Z

🎉 Build successful!
Completed in 19:21

brawl-done

Approved by: @lennartkloock @philipch07
Pushing 9f7fb80 to main

TroyKomodo requested review from a team as code owners May 13, 2025 22:59

philipch07 reviewed May 13, 2025

View reviewed changes

crates/aac/src/lib.rs Outdated Show resolved Hide resolved

philipch07 reviewed May 13, 2025

View reviewed changes

TroyKomodo requested a review from lennartkloock May 14, 2025 02:42

philipch07 approved these changes May 14, 2025

View reviewed changes

clean up docs

a2ab69b

TroyKomodo force-pushed the troy/crate-docs branch 2 times, most recently from b3158d1 to 0d562c5 Compare May 14, 2025 04:10

scuffle-brawl bot added the B-brawl-queued label May 14, 2025

scuffle-brawl bot added B-brawl-merging and removed B-brawl-queued labels May 14, 2025

TroyKomodo added the change-log-not-required label May 14, 2025

scuffle-brawl bot added B-brawl-failed and removed B-brawl-merging labels May 14, 2025

scuffle-brawl bot added B-brawl-queued and removed B-brawl-failed labels May 14, 2025

scuffle-brawl bot added B-brawl-failed and removed B-brawl-merging labels May 14, 2025

feature gate pprof docs

5041ea5

TroyKomodo force-pushed the troy/crate-docs branch from 8fc4f64 to 5041ea5 Compare May 15, 2025 04:41

scuffle-brawl bot added B-brawl-queued and removed B-brawl-failed labels May 15, 2025

scuffle-brawl bot added B-brawl-merging and removed B-brawl-queued labels May 15, 2025

scuffle-brawl bot added B-brawl-failed and removed B-brawl-merging labels May 15, 2025

fix signal windows tests

d3a7c0e

scuffle-brawl bot added B-brawl-queued and removed B-brawl-failed labels May 15, 2025

scuffle-brawl bot added B-brawl-merging and removed B-brawl-queued labels May 15, 2025

scuffle-brawl bot added B-brawl-merged and removed B-brawl-merging labels May 15, 2025

scuffle-brawl bot merged commit 9f7fb80 into main May 15, 2025
11 of 17 checks passed

scuffle-brawl bot deleted the troy/crate-docs branch May 15, 2025 05:11

github-actions bot mentioned this pull request May 15, 2025

fix workspace deps #460

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cleanup crate docs #458

cleanup crate docs #458

TroyKomodo commented May 13, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented May 13, 2025 •

edited

Loading

github-actions bot commented May 13, 2025 •

edited

Loading

error: running cargo-doc on crate 'scuffle-h264' failed with output:

error: running cargo-doc on crate 'scuffle-h265' failed with output:

cloudflare-workers-and-pages bot commented May 13, 2025 •

edited

Loading

codecov bot commented May 13, 2025 •

edited

Loading

TroyKomodo commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

TroyKomodo commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

TroyKomodo commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

TroyKomodo commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

cleanup crate docs #458

cleanup crate docs #458

Conversation

TroyKomodo commented May 13, 2025 • edited Loading

cloudflare-workers-and-pages bot commented May 13, 2025 • edited Loading

Deploying scuffle-docusaurus-docs with Cloudflare Pages

github-actions bot commented May 13, 2025 • edited Loading

error: running cargo-doc on crate 'scuffle-h264' failed with output:

error: running cargo-doc on crate 'scuffle-h265' failed with output:

Semver-checks summary

✅ No semver violations found! ✅

cloudflare-workers-and-pages bot commented May 13, 2025 • edited Loading

Deploying scuffle-docrs with Cloudflare Pages

codecov bot commented May 13, 2025 • edited Loading

Codecov Report

TroyKomodo commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

TroyKomodo commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

scuffle-brawl bot commented May 14, 2025

TroyKomodo commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

TroyKomodo commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

scuffle-brawl bot commented May 15, 2025

TroyKomodo commented May 13, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented May 13, 2025 •

edited

Loading

github-actions bot commented May 13, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented May 13, 2025 •

edited

Loading

codecov bot commented May 13, 2025 •

edited

Loading