Merge pull request #4166 from TheBlueMatt/2025-10-0.1.7

Cut 0.1.7

Author: TheBlueMatt

.github/workflows/build.yml

@@ -208,6 +208,24 @@ jobs:
           RUSTFLAGS: '--cfg=taproot'
           RUSTDOCFLAGS: '--cfg=taproot'
 
+  check_docs:
+    runs-on: self-hosted
+    env:
+      # While docs.rs builds using a nightly compiler (and we use some nightly features),
+      # nightly ends up randomly breaking builds occasionally, so we instead use beta
+      # and set RUSTC_BOOTSTRAP in check-docsrs.sh
+      TOOLCHAIN: beta
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+        run: |
+          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
+      - name: Simulate docs.rs build
+        run: ci/check-docsrs.sh
+
   fuzz:
     runs-on: ubuntu-latest
     env:

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.7 - Oct 21, 2025 - "Unstable Release CI"
+
+## Bug Fixes
+ * Builds with the `docsrs` cfg flag (set automatically for builds on docs.rs
+   but otherwise not used) were fixed.
+
+
 # 0.1.6 - Oct 10, 2025 - "Async Preimage Claims"
 
 ## Performance Improvements
@@ -36,6 +43,7 @@
    it. This allows a peer which opens channels without funding them to bloat our
    memory and disk space, eventually leading to denial-of-service (#4081).
 
+
 # 0.1.5 - Jul 16, 2025 - "Async Path Reduction"
 
 ## Performance Improvements

ci/check-docsrs.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+#shellcheck disable=SC2002,SC2086,SC2207
+
+set -ex
+
+# Attempt to simulate the docsrs builds. Sadly its not entirely trivial as
+# docs.rs reads metadata out of Cargo.toml which we don't want to have a whole
+# parser for.
+
+WORKSPACE_MEMBERS=( $(cat Cargo.toml | tr '\n' '\r' | sed 's/\r    //g' | tr '\r' '\n' | grep '^members =' | sed 's/members.*=.*\[//' | tr -d '"' | tr ',' '\n') )
+echo "${WORKSPACE_MEMBERS[@]}"
+for CRATE in "${WORKSPACE_MEMBERS[@]}"; do
+	pushd "$CRATE"
+	CARGO_ARGS=""
+	RUSTDOC_ARGS=""
+	cat Cargo.toml | grep -A 100 '\[package.metadata.docs.rs\]' | tail -n +2 > /tmp/ldk-docsrs-rustdoc-config.txt
+	while read -r LINE; do
+		case "$LINE" in
+			"["*) break;;
+			"features"*)
+				OG_IFS="$IFS"
+				IFS=','
+				for FEATURE in $(echo "$LINE" | sed 's/features.*=.*\[//g' | tr -d '"] '); do
+					export CARGO_ARGS="$CARGO_ARGS --features $FEATURE"
+				done
+				IFS="$OG_IFS"
+				;;
+			"all-features = true")
+				export CARGO_ARGS="$CARGO_ARGS --all-features"
+				;;
+			"rustdoc-args"*)
+				RUSTDOC_ARGS="$(echo "$LINE" | sed 's/rustdoc-args.*=.*\[//g' | tr -d '"],')"
+				;;
+		esac
+	done < /tmp/ldk-docsrs-rustdoc-config.txt
+	rm /tmp/ldk-docsrs-rustdoc-config.txt
+	echo "Building $CRATE with args $CARGO_ARGS and flags $RUSTDOC_ARGS"
+	# We rely on nightly features but want to use a stable release in CI to avoid
+	# spurous breakage, thus we set RUSTC_BOOTSTRAP=1 here.
+	RUSTC_BOOTSTRAP=1 cargo rustdoc $CARGO_ARGS -- $RUSTDOC_ARGS
+	popd
+done

ci/ci-tests.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+#shellcheck disable=SC2002,SC2207
 set -eox pipefail
 
 RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
@@ -41,23 +42,7 @@ export RUST_BACKTRACE=1
 echo -e "\n\nChecking the workspace, except lightning-transaction-sync."
 cargo check --verbose --color always
 
-# When the workspace members change, make sure to update the list here as well
-# as in `Cargo.toml`.
-WORKSPACE_MEMBERS=(
-	lightning
-	lightning-types
-	lightning-block-sync
-	lightning-invoice
-	lightning-net-tokio
-	lightning-persister
-	lightning-background-processor
-	lightning-rapid-gossip-sync
-	lightning-custom-message
-	lightning-macros
-	lightning-dns-resolver
-	lightning-liquidity
-	possiblyrandom
-)
+WORKSPACE_MEMBERS=( $(cat Cargo.toml | tr '\n' '\r' | sed 's/\r    //g' | tr '\r' '\n' | grep '^members =' | sed 's/members.*=.*\[//' | tr -d '"' | tr ',' ' ') )
 
 echo -e "\n\nChecking, testing, and building docs for all workspace members individually..."
 for DIR in "${WORKSPACE_MEMBERS[@]}"; do

lightning-background-processor/src/lib.rs

@@ -5,7 +5,7 @@
 #![deny(rustdoc::private_intra_doc_links)]
 #![deny(missing_docs)]
 #![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
 
 #[cfg(any(test, feature = "std"))]

lightning-block-sync/src/lib.rs

@@ -17,7 +17,7 @@
 #![deny(rustdoc::private_intra_doc_links)]
 #![deny(missing_docs)]
 #![deny(unsafe_code)]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 #[cfg(any(feature = "rest-client", feature = "rpc-client"))]
 pub mod http;

lightning-invoice/src/lib.rs

@@ -5,7 +5,7 @@
 #![deny(non_camel_case_types)]
 #![deny(non_snake_case)]
 #![deny(unused_mut)]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
 
 //! This crate provides data structures to represent

lightning-liquidity/src/lib.rs

@@ -44,7 +44,7 @@
 #![allow(bare_trait_objects)]
 #![allow(ellipsis_inclusive_range_patterns)]
 #![allow(clippy::drop_non_drop)]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(not(feature = "std"), no_std)]
 
 #[macro_use]

lightning-macros/src/lib.rs

@@ -16,7 +16,7 @@
 #![forbid(unsafe_code)]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 use proc_macro::TokenStream;
 use quote::quote;

lightning-net-tokio/src/lib.rs

@@ -25,7 +25,7 @@
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
 #![deny(missing_docs)]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 use bitcoin::secp256k1::PublicKey;