DiamondLightSource / DiamondLightSource/python-copier-template

Use GitHub pages direct deployment

Offen
#35 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
deferred
Vorherrschende Sprache
Jinja
Sterne
25
Forks
10
Ø Merge
4 Std. 4 Min.
Gemergte PRs (30 T.)
6

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github-actions, python
Bereich
ci-cd, documentation, release
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.