Skip to content

Disable docs build verification in CI for non-lib crates #1799

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

Merged
spacebear21 merged 2 commits into from
Aug 11, 2026
Merged

Disable docs build verification in CI for non-lib crates #1799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e91d9c
Update download artifact action
benalleng Aug 6, 2026
d051171
Skip doc builds for non lib crates when verifying publishes
benalleng Aug 6, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/crates-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ jobs:
- name: Use nix cache
uses: DeterminateSystems/magic-nix-cache-action@main
- name: Download packaged crate
uses: actions/download-artifact@v4
uses: actions/download-artifact@v8
with:
name: crate
path: dist
Expand Down
19 changes: 14 additions & 5 deletions contrib/release/verify-published.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,17 @@ published_sha="$(poll "${CRATES_IO_ATTEMPTS:-30}" \
die "checksum mismatch: crates.io $published_sha vs local $local_sha"
echo "crates.io checksum matches the attested .crate ($local_sha)"

echo "Waiting for docs.rs to build $crate $version (${DOCS_RS_ATTEMPTS:-60} checks, ${interval}s apart)"
poll "${DOCS_RS_ATTEMPTS:-60}" \
"https://docs.rs/crate/$crate/$version/status.json" 'select(.doc_status == true) | "built"' >/dev/null ||
die "docs.rs did not build $crate $version"
echo "docs.rs built $crate $version"
# docs.rs builds documentation only for crates with a library target;
# binary-only crates (e.g. payjoin-cli) never reach doc_status == true.
if cargo metadata --format-version 1 --no-deps 2>/dev/null |
jq -e --arg c "$crate" \
'any(.packages[] | select(.name == $c) | .targets[].kind[]; . | test("^(lib|rlib|dylib|cdylib|staticlib|proc-macro)$"))' \
>/dev/null; then
echo "Waiting for docs.rs to build $crate $version (${DOCS_RS_ATTEMPTS:-60} checks, ${interval}s apart)"
poll "${DOCS_RS_ATTEMPTS:-60}" \
"https://docs.rs/crate/$crate/$version/status.json" 'select(.doc_status == true) | "built"' >/dev/null ||
die "docs.rs did not build $crate $version"
echo "docs.rs built $crate $version"
else
echo "Skipping docs.rs check for $crate (no library target)"
fi
Loading