Skip to content

Conversation

@cgwalters
Copy link
Collaborator

These external git dependencies don't have docs on docs.rs, so include them in the internal documentation alongside our workspace crates.

Assisted-by: OpenCode (Opus 4.5)

@github-actions github-actions bot added the area/documentation Updates to the documentation label Jan 8, 2026
@bootc-bot bootc-bot bot requested a review from jeckersb January 8, 2026 14:22
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation build process to include rustdoc for the external composefs-rs git dependencies. The changes modify docs/Dockerfile.mdbook to generate the documentation and docs/src/internals.md to add links to it. This is a good addition as it makes documentation for these key dependencies available locally. The implementation is correct, but I have one suggestion to ensure the generated documentation for the external crates is as comprehensive as for the internal ones.

jeckersb
jeckersb previously approved these changes Jan 8, 2026
Copy link
Collaborator

@jeckersb jeckersb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, sanity checked locally. Not sure why the docs job is failing in CI, it works fine for me locally and it's all done in the container build so I don't see why it would be any different in CI...

@cgwalters
Copy link
Collaborator Author

It's because

INFO has_release_artifact{release=GhRelease { repo: GhRepo { owner: "cargo-bins", repo: "cargo-quickinstall" }, tag: "mdbook-linkcheck-0.7.7" } artifact_name="mdbook-linkcheck-0.7.7-x86_64-unknown-linux-gnu.tar.gz"}:do_send_request{request=Request { method: GET, url: Url { scheme: "https", cannot_be_a_base: false, username: "", password: None, host: Some(Domain("api.github.com")), port: None, path: "/repos/cargo-bins/cargo-quickinstall/releases/tags/mdbook-linkcheck-0.7.7", query: None, fragment: None }, headers: {"accept": "application/vnd.github+json", "x-github-api-version": "2022-11-28"} } url=https://api.github.com/repos/cargo-bins/cargo-quickinstall/releases/tags/mdbook-linkcheck-0.7.7}: Received status code 403 Forbidden, will wait for 120s and retry

So cargo-binstall falls back to building from source which for bad reasons also includes building openssl from source which for historical reasons requires Perl stuff we don't ship in the devenv.

These external git dependencies don't have docs on docs.rs, so include
them in the internal documentation alongside our workspace crates.

Assisted-by: OpenCode (Opus 4.5)
Signed-off-by: Colin Walters <walters@verbum.org>
Add a comment noting that changes to the composefs-rs crate list should
also update the documentation files that reference them.

Assisted-by: OpenCode (Opus 4.5)
Signed-off-by: Colin Walters <walters@verbum.org>
When cargo-binstall fetches pre-built binaries from GitHub, it can hit
API rate limits (403 Forbidden) when unauthenticated. This causes it to
fall back to building from source, which fails for mdbook-linkcheck
because the devenv container lacks openssl-devel and the perl modules
needed to build OpenSSL from source.

Pass the GitHub Actions token through to the container build as a secret,
allowing cargo-binstall to make authenticated requests with higher rate
limits.

Assisted-by: OpenCode (claude-sonnet-4-20250514)
Signed-off-by: Colin Walters <walters@verbum.org>
@cgwalters
Copy link
Collaborator Author

I tried adding a commit here to propagate the github token into the podman build, which I think will mean that cargo-binstall provides it when doing fetches which should avoid having us be ratelimited as if we were doing anonymous requests.

@cgwalters cgwalters enabled auto-merge (rebase) January 8, 2026 17:43
Copy link
Collaborator

@jeckersb jeckersb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops forgot I have to re-review now 😆

@cgwalters cgwalters merged commit 0ee11db into bootc-dev:main Jan 8, 2026
46 of 47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Updates to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants