DiamondLightSource / DiamondLightSource/python-copier-template

Use GitHub pages direct deployment

Abierto
#35 1 comentario 1 reacción 0 asignados Ver en GitHub
deferred
Lenguaje dominante
Jinja
Estrellas
25
Forks
10
Merge medio
4 h 4 min
PR fusionados (30 d)
6

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github-actions, python
Área
ci-cd, documentation, release
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.