DiamondLightSource / DiamondLightSource/python-copier-template
Use GitHub pages direct deployment
- Linguagem predominante
- Jinja
- Estrelas
- 25
- Forks
- 10
- Merge médio
- 4h 4min
- PRs com merge (30d)
- 6
Descrição
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
Guia de contribuição
Direção de pesquisa
Revise primeiro o deployment atual de gh-pages e o PR de deployment do GitHub Pages referenciado. Rastreie como os artefatos de documentação, switcher.json, tags, releases e main são tratados. Considera-se concluído quando os docs forem compilados como artefatos, os deployments de release e main montarem o site necessário e os diretórios de tags existentes de gh-pages forem migrados para releases.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- github-actions, python
- Domínio
- ci-cd, documentation, release
- Tipo de issue
- Funcionalidade
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 30/100