Skip to content

ci: standardize docs workflow#18

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

ci: standardize docs workflow#18
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/data/ 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 CI workflow to match the shared “website handoff” deployment pattern, using uv to build MkDocs output and (optionally) pushing the built site/ to the website repository when a deploy key is available.

Changes:

  • Pins astral-sh/setup-uv to a specific commit (v8.1.0) for more deterministic action behavior.
  • Builds docs via uv run mkdocs build.
  • Gates the deploy step so it only runs when DOCS_DEPLOY_KEY is present, and deploys site/ to website/static/docs/data/.

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


- name: Deploy to website repo
if: ${{ env.DOCS_DEPLOY_KEY != '' }}
uses: cpina/github-action-push-to-another-repository@v1.7.2

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.

cpina/github-action-push-to-another-repository@v1.7.2 is a third-party action referenced by a movable tag. Since this workflow uses an SSH deploy key, consider pinning this action to an exact commit SHA (and optionally documenting the corresponding version) to reduce supply-chain risk from tag retargeting.

Copilot uses AI. Check for mistakes.
Comment on lines +19 to +20
env:
DOCS_DEPLOY_KEY: ${{ secrets.DOCS_DEPLOY_KEY }}

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.

DOCS_DEPLOY_KEY is being exported at the job level, which makes the deploy key available to every step (including third-party actions like actions/checkout and astral-sh/setup-uv). To follow least-privilege, scope the secret to only the deploy step and use if: ${{ secrets.DOCS_DEPLOY_KEY != '' }} (or similar) instead of routing it through env at the job level.

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