DiamondLightSource / DiamondLightSource/python-copier-template

Use GitHub pages direct deployment

Ouverte
#35 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub
deferred
Langage dominant
Jinja
Étoiles
25
Forks
10
Merge moyen
4 h 4 min
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github-actions, python
Domaine
ci-cd, documentation, release
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.