Skip to content

ci: standardize docs workflow#20

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

ci: standardize docs workflow#20
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/backtest/ 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 docs build/deploy workflow to follow the shared “website handoff” pattern, building MkDocs output with uv and (when a deploy key is present) pushing the generated site/ to the website repo under the existing docs path.

Changes:

  • Pins astral-sh/setup-uv to a specific commit (v8.1.0) and builds docs via uv run mkdocs build.
  • Adds conditional deployment to ml4t/website when DOCS_DEPLOY_KEY is present.
  • Routes the deploy key through an environment variable for the push action.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +19 to 21
env:
DOCS_DEPLOY_KEY: ${{ secrets.DOCS_DEPLOY_KEY }}
steps:
@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