Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use GitHub pages direct deployment #35

Open
Tracked by #2
coretl opened this issue Jan 29, 2024 · 1 comment
Open
Tracked by #2

Use GitHub pages direct deployment #35

coretl opened this issue Jan 29, 2024 · 1 comment
Labels

Comments

@coretl
Copy link
Contributor

coretl commented Jan 29, 2024

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 DiamondLightSource/python3-pip-skeleton#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
@coretl coretl changed the title Remove versioning of docs, use the new pages deployment actions, and provide a conversion script that puts existing version on a branch Use GitHub pages direct deployment Jan 29, 2024
@coretl
Copy link
Contributor Author

coretl commented May 1, 2024

If we wanted to maintain branch builds as well we could grab from any valid artifact caches, but we have the problem of what happens if you push a branch build and the main build artifact cache has expired.

The other alternative to this is to keep using the gh-pages branch, but squash on each deploy. The action almost does this, but not quite until peaceiris/actions-gh-pages#455 is fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant