Skip to content

Fix docs deploy dependency setup - #543

Merged
Zhiyuan He (hzy46) merged 2 commits into
mainfrom
copilot/fix-failing-github-actions-job-deploy
Aug 17, 2026
Merged

Fix docs deploy dependency setup#543
Zhiyuan He (hzy46) merged 2 commits into
mainfrom
copilot/fix-failing-github-actions-job-deploy

Conversation

Copilot AI commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

The Deploy Documentation job failed because uv run --locked --no-sync mike ... was invoked after syncing only dev dependencies, leaving the mike CLI unavailable.

  • Docs dependencies

    • Added a dedicated docs dependency group for mike and the MkDocs plugins used by mkdocs.yml.
    • Updated uv.lock so the deploy job remains locked and reproducible.
  • Deploy workflow

    • Updated the docs workflow dependency sync to install both dev and docs groups before deployment.
uv sync --frozen --no-default-groups --group dev --group docs

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
@hzy46
Zhiyuan He (hzy46) marked this pull request as ready for review August 17, 2026 04:54
Copilot AI lite review requested due to automatic review settings August 17, 2026 04:54
@hzy46
Zhiyuan He (hzy46) merged commit 5e9c711 into main Aug 17, 2026
4 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 docs dependency group in pyproject.toml for mike and the MkDocs plugins used by mkdocs.yml.
  • Updated the docs GitHub Actions workflow to uv sync both dev and docs groups before running mike.
  • Updated uv.lock to include the new docs dependency 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants