DiamondLightSource / DiamondLightSource/python-copier-template
Use GitHub pages direct deployment
- 主要语言
- Jinja
- 星标
- 25
- 派生
- 10
- 平均合并
- 4 小时 4 分钟
- 30 天内合并 PR
- 6
描述
At the moment we push to the `gh-pages` branch. This adds to the size of the repo, and this is why we switched to only publishing `main` and releases. We should try using the new pages deployment like https://github.com/DiamondLightSource/python3-pip-skeleton/pull/133. The downside is that we cannot incrementally deploy, we need to push the whole site each time. To do this we should:
- Always build docs, and store as artifact
- Maintain switcher.json manually
- On tag then store artifact on release and create a PR to update switcher,json
- On push to main, create site from main + unzipped artifacts from all releases in switcher.json
- Make a migration that uploads every tag directory in gh-pages to the relevant release
贡献指南
调研方向
Review the current gh-pages deployment and the referenced GitHub Pages deployment PR first. Trace how documentation artifacts, switcher.json, tags, releases, and main are handled. Done means docs are built as artifacts, release and main deployments assemble the required site, and existing gh-pages tag directories are migrated to releases.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github-actions, python
- 领域
- ci-cd, documentation, release
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 30/100