ci(docs): build API docs from uv.lock instead of a fresh PyPI resolve - #365
Merged
Merged
Conversation
The docs job ran `uv pip install '.[docs]'`, which re-resolves the whole environment and breaks on unrelated upstream releases. Sync the checkout's lock (docs extra, --frozen --inexact) into the image's venv and install the checkout --no-deps on top. PRs build docs only when docs inputs change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Uemfjv9ybCwtKtprksZbVY
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.
The docs job ran
uv pip install '.[docs]'inside the image. That re-resolves the whole environment from PyPI, so an unrelated upstream release can fail every PR's docs check. The latest example is shear-psf-leakage 0.2.1 against cs-util 0.2.2's scipy cap.This PR installs the docs from the lock instead:
uv sync --frozen --inexact --extra docsinstalls exactly what the checkout'suv.lockpins into the image's venv, and leaves the rest of the image's stack in place.uv pip install --no-deps -e .then installs the checked-out package on top. The project isn't uv-packaged, so without this line autodoc would document the copy baked into the image.docs/,src/,pyproject.toml,uv.lockor this workflow change.developdeploy to Pages.I checked it locally in the
:developSIF: the sync installs only locked versions and the Sphinx build completes against the checkout. This works together with #362, whichever merges first.— Claude (Opus) on behalf of Cail
🤖 Generated with Claude Code