release: 0.2.6 (docs.rs fix + README table reordering)#36
Merged
Conversation
`doc_auto_cfg` was removed in Rust 1.92.0 and folded back into `doc_cfg` (rust-lang/rust#138907). docs.rs builds with the latest nightly and sets `--cfg docsrs`, so the previous #![cfg_attr(docsrs, feature(doc_auto_cfg))] aborts compilation with E0557 on every published 0.2.x. GitHub CI never tripped this — stable rustc ignores the line because nothing sets the `docsrs` cfg there. Switch all three published library crates (`wickra`, `wickra-core`, `wickra-data`) to the merged-into `doc_cfg` gate. Same intent, same on-docs.rs output, builds again on nightly.
Reorders the "Why Wickra exists" library-comparison table and the two benchmark headers so Wickra is the first row (with a ★ marker) instead of the last. The previous order placed Wickra at the bottom, which buries the only row a reader landing on the README is here to compare against. Same column data, same ★/winner annotations, just the row order flipped and a ★ prefix on the Wickra label. Mirrored across the umbrella README and every binding README so the crates.io / PyPI / npm landing pages stay in sync.
Workspace, every binding (Python, Node, Node platform stubs), the release.yml comment and the CHANGELOG all move together to 0.2.6 so the next tagged release lines every artefact up. 0.2.6 carries two changes from the [0.2.6] CHANGELOG entry: - fix(docs-rs): swap the now-removed `doc_auto_cfg` feature gate for the merged-into `doc_cfg` so docs.rs nightly builds resume. - docs(readme): float ★ Wickra to the top of every comparison table across the umbrella + binding READMEs. wickra-win32-arm64-msvc stays excluded for this release with the same npm spam-filter rationale that held for 0.2.5.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three commits land together for the 0.2.6 patch:
fix(docs-rs)—doc_auto_cfgwas removed in Rust 1.92 and merged intodoc_cfg(Implement RFC 3631: add rustdoc doc_cfg features rust-lang/rust#138907). docs.rs builds against the latest nightly with--cfg docsrs, so every published 0.2.x tripped E0557 on the#![cfg_attr(docsrs, feature(doc_auto_cfg))]lines inwickra,wickra-core,wickra-data. Stable rustc never enables that cfg, so GitHub CI couldn't see it. All three crates now gate ondoc_cfg(same rendered output, builds again on nightly).docs(readme)— Wickra is now the first row of every comparison table across the umbrella + binding READMEs (with a ★ marker), instead of the last. Same column data, same winner annotations, just the pivot row in the position a reader actually wants it.release: bump— workspace, every binding (Python, Node, 5 platform stubs), therelease.ymlcomment, and theCHANGELOGall move from 0.2.5 → 0.2.6.wickra-win32-arm64-msvcstays excluded with the same npm-spam-filter rationale.Test plan
cargo fmt --all --checkcargo clippy --workspace --all-targets --all-features -- -D warningscargo test --workspace --all-features— every crate greengrep "0\.2\.5"shows only the historical CHANGELOG entries + one historical "Since 0.2.5, BinanceConfig" doc-linev0.2.6tag push: docs.rs successfully builds 0.2.6 (the whole reason for this PR)