Fix docs deploy dependency setup - #543
Merged
Zhiyuan He (hzy46) merged 2 commits intoAug 17, 2026
Merged
Conversation
Co-authored-by: hzy46 <7499023+hzy46@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix the failing GitHub Actions job deploy
Fix docs deploy dependency setup
Aug 17, 2026
Zhiyuan He (hzy46)
approved these changes
Aug 17, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the documentation deployment workflow by ensuring the mike CLI and MkDocs-related plugins are installed via a dedicated docs dependency group and syncing that group in the deploy job, keeping the workflow locked and reproducible.
Changes:
- Added a
docsdependency group inpyproject.tomlformikeand the MkDocs plugins used bymkdocs.yml. - Updated the docs GitHub Actions workflow to
uv syncbothdevanddocsgroups before runningmike. - Updated
uv.lockto include the newdocsdependency group and its resolved packages.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
uv.lock |
Adds a docs group and locks the additional docs tooling dependencies. |
pyproject.toml |
Defines the new docs dependency group for documentation build/deploy tooling. |
.github/workflows/docs.yml |
Syncs both dev and docs groups so uv run ... mike ... can execute during deploy. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Deploy Documentationjob failed becauseuv run --locked --no-sync mike ...was invoked after syncing only dev dependencies, leaving themikeCLI unavailable.Docs dependencies
docsdependency group formikeand the MkDocs plugins used bymkdocs.yml.uv.lockso the deploy job remains locked and reproducible.Deploy workflow
uv sync --frozen --no-default-groups --group dev --group docs