ci: standardize docs workflow#1
Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes the documentation deployment workflow to follow the shared “website handoff” pattern, including pinning the setup-uv action and deploying the built MkDocs site to the website repository when a deploy key is available.
Changes:
- Update the docs workflow to use a pinned
astral-sh/setup-uvcommit (v8.1.0). - Build docs via
uv run mkdocs buildand deploysite/intowebsite/static/docs/models/whenDOCS_DEPLOY_KEYis present. - Update the checkout action reference in the docs workflow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - name: Build docs | ||
| run: uv run mkdocs build --strict | ||
| run: uv run mkdocs build |
There was a problem hiding this comment.
Dropping --strict from the MkDocs build step reduces CI signal (warnings like broken links no longer fail the job). If the intent is to keep docs quality gates, consider restoring --strict or adding an explicit rationale/alternative check so regressions don’t get deployed.
| run: uv run mkdocs build | |
| run: uv run mkdocs build --strict |
|
Superseded by the later GitHub Actions/Dependabot maintenance PR that has already been merged to main. |
Summary
Notes