Skip to content

ci: standardize docs workflow#1

Closed
stefan-jansen wants to merge 1 commit into
mainfrom
ci/standardize-docs-workflow
Closed

ci: standardize docs workflow#1
stefan-jansen wants to merge 1 commit into
mainfrom
ci/standardize-docs-workflow

Conversation

@stefan-jansen

Copy link
Copy Markdown
Contributor

Summary

  • standardize the library docs deployment workflow on the shared website handoff pattern
  • pin astral-sh/setup-uv to the official v8.1.0 commit from Astral's setup-uv documentation
  • build docs with uv run mkdocs build and deploy site/ to website/static/docs/models/ when the deploy key is present

Notes

  • preserves the existing website-side docs rendering and navbar injection contract
  • keeps the deploy target and URL structure unchanged

Copilot AI review requested due to automatic review settings April 29, 2026 16:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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-uv commit (v8.1.0).
  • Build docs via uv run mkdocs build and deploy site/ into website/static/docs/models/ when DOCS_DEPLOY_KEY is 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

Copilot AI Apr 29, 2026

Copy link

Choose a reason for hiding this comment

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

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.

Suggested change
run: uv run mkdocs build
run: uv run mkdocs build --strict

Copilot uses AI. Check for mistakes.
@stefan-jansen

Copy link
Copy Markdown
Contributor Author

Superseded by the later GitHub Actions/Dependabot maintenance PR that has already been merged to main.

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.

2 participants