[chore]: fix requirements to build whl#1436
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes the docs optional dependency group from pyproject.toml and updates the build-docs workflow to install the mkdocstrings-parser package directly as a Git dependency. This change prevents pip from attempting to resolve the Git-based dependency during wheel builds, which was causing failures during release processes.
Changes:
- Removed the
docsoptional dependency group containing the Git-basedmkdocstrings-parserdependency frompyproject.toml - Updated the build-docs workflow to install
mkdocstrings-parserdirectly via Git URL instead of through the[docs]extra
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Removed the docs optional dependency group to prevent Git dependencies from breaking wheel builds |
| .github/workflows/build-docs.yaml | Updated to install mkdocstrings-parser directly as a Git dependency instead of via the removed [docs] extra |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
elephaint
left a comment
There was a problem hiding this comment.
Why not via dependency-groups? Let's keep solutions same for all repos
This reverts commit 77b8699.
elephaint
left a comment
There was a problem hiding this comment.
PR Review Summary
Overall this is a clean modernization PR migrating to uv sync with dependency groups. A few items need attention:
Issue: Missing docs dependency group
CONTRIBUTING.md line 188 references --group docs, but this group doesn't exist in pyproject.toml. The old docs dependencies (mkdocstrings-parser) were merged into the dev group. Either:
- Remove
--group docsfrom CONTRIBUTING.md, OR - Create a separate
docsgroup if keeping documentation deps isolated is desired
Minor: Inconsistent uv usage in lint.yaml
The lint workflow uses uv pip install --system pre-commit while other workflows use uv sync. Consider using uv sync --group dev for consistency, since pre-commit is in the dev group.
Note: CI coverage enforcement
CircleCI now runs with --no-cov, meaning coverage enforcement (80% threshold) relies solely on GitHub Actions' ubuntu/windows jobs. This is fine if intentional.
Consider: Dependency caching
None of the workflows cache uv/pip dependencies. Given the heavy ML dependencies, adding caching could significantly improve CI times.
This PR fixes the requirements so that the
whlcan be built during a releasegroup-dependencyinstead ofproject.optional-dependenciesin pyproject.toml