ci(docs): restore auto-deploy to UniLab-doc gh-pages on push to main - #1503
Merged
Conversation
The deploy job removed in a2f2994 is restored: after the prose-only check build passes on main, a deploy job runs the full Sphinx build (UniLab installed, autodoc enabled, prose-only fallback on install failure) and pushes to unilabsim/UniLab-doc gh-pages via the existing UNILAB_DOC_DEPLOY_KEY secret. workflow_dispatch on main takes the same path; the manual local publish flow stays as fallback.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
文档站点 unilabsim.github.io/UniLab-doc 自 2026-06-04 起停更。
a2f2994b（docs: make docs ci prose-only）移除了 docs.yml 中的 deploy job 后，发布变成纯手动流程，3 个月无人执行。改动
.github/workflows/docs.yml：恢复deployjob —— push 到main（或在 main 上workflow_dispatch）时，在 prose-only 检查构建通过后执行完整 Sphinx 构建（安装 UniLab、启用 autodoc；安装失败自动降级 prose-only 并仍然部署），通过既有的UNILAB_DOC_DEPLOY_KEYsecret 推送到unilabsim/UniLab-doc的gh-pages分支，GitHub Pages 自动更新站点。PR 检查保持轻量 prose-only build 不变。docs/sphinx/README.md：CI/部署一节更新为自动部署描述，本地手动发布流程保留为 fallback。Validation
make test-all在最终 head（3c6d3554）通过：lint 全过，1568 passed, 20 skipped, 1 xfaileduv run pytest tests/scripts/test_check_docs.py -q：20 passedsphinx-build -j auto -b html -n source build/html，含 autodoc）成功，验证 deploy job 的构建步骤可用；191 条警告均为既有内容警告，不阻塞（未启用 -W）备注
UNILAB_DOC_DEPLOY_KEYsecret 仍在仓库设置中（更新于 2026-05-27），无需重新配置。