ci: add docs.rs compatibility checks - #649
Open
par1ram wants to merge 1 commit into
Open
Conversation
par1ram
force-pushed
the
codex/issue-524-docs-rs-ci
branch
from
July 27, 2026 07:23
f7573bf to
410d48e
Compare
par1ram
marked this pull request as ready for review
July 28, 2026 13:28
bit-aloo
reviewed
Aug 3, 2026
| echo "Building docs for ${manifest_path} in no-network sandbox" | ||
| export MANIFEST_PATH="$manifest_path" | ||
| export CARGO_BIN="$cargo_bin" | ||
| sudo --preserve-env=MANIFEST_PATH,CARGO_BIN,PATH,CARGO_HOME,RUSTUP_HOME,HOME unshare --net --mount-proc bash -lc \ |
par1ram
force-pushed
the
codex/issue-524-docs-rs-ci
branch
from
August 3, 2026 08:31
410d48e to
ecd98fa
Compare
Member
|
@par1ram on this project we try to keep a reasonable level of git hygiene if a reviewer asks you to change something, please don't add a new commit pivoting commit history to a new direction... simply rebase the original commit while atomically incorporating the review in other words: ecd98fa shouldn't exist as a standalone commit |
Build each published crate with cargo-docs-rs inside an offline network namespace so sandbox-only documentation regressions fail in CI.
par1ram
force-pushed
the
codex/issue-524-docs-rs-ci
branch
from
August 12, 2026 18:30
ecd98fa to
43f6c1a
Compare
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
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
cargo docs-rs --offlineinside an isolated Linux network namespacedocs-rs-check.shhelperWhy
docs.rs builds crates without network access. A regular documentation build can therefore miss regressions where a dependency or build script attempts a download, as happened in #519.
This adds a focused regression check while keeping the implementation smaller than running the full docs.rs infrastructure.
Closes #524.
Validation
cargo +nightly docs-rs --offlinepassed for:stratum-appspool_sv2jd_server_sv2jd_client_sv2translator_sv2integration_tests_sv2bitcoin_core_sv2actionlint .github/workflows/docs-rs.yamlshellcheck scripts/docs-rs-check.shbash -n scripts/docs-rs-check.shgit diff --checkThe full Linux network-namespace path is exercised by the new workflow on this pull request.