DiamondLightSource / DiamondLightSource/python-copier-template

Use GitHub pages direct deployment

Open
#35 1 comment 1 reaction 0 assignees View on GitHub
deferred
Dominant language
Jinja
Stars
25
Forks
10
Avg merge
4h 4m
Merged PRs (30d)
6

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.