DiamondLightSource / DiamondLightSource/python-copier-template

Use GitHub pages direct deployment

Aperta
#35 1 commento 1 reazione 0 assegnatari Vedi su GitHub
deferred
Lingua principale
Jinja
Stelle
25
Fork
10
Merge medio
4h 4m
PR unite (30g)
6

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Esamina innanzitutto il deployment corrente di gh-pages e la PR di deployment di GitHub Pages a cui si fa riferimento. Traccia come vengono gestiti gli artefatti della documentazione, switcher.json, tags, releases e main. Il lavoro è completato quando i docs vengono creati come artefatti, i deployment di release e main assemblano il sito richiesto e le directory dei tag esistenti di gh-pages vengono migrate in releases.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, python
Ambito
ci-cd, documentation, release
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.