Repository navigation
ci: update docs publishing using myst-version-switcher-plugin - #373
shree-iyengar-dls wants to merge 38 commits into
Conversation
|
@coretl can you have look at this PR, I would like this to be deployed on dodal as well to improve the clone speed dodal has 110 releases compared to 192 of blueapi so hopefully it should be okay |
|
I revisited this just now and because I couldn't remember if I had done the backfill last time as mentioned in the How-to-page, I tried to run it again but got an error:
The GitHub Actions also seems to have failed. |
The shared docs workflow only installs uv, so sphinx.ext.graphviz warns that 'dot' is missing and --fail-on-warning fails the build. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
faa8237 to
663b651
Compare
coretl
left a comment
There was a problem hiding this comment.
Please can you also:
- Delete
.github/pages/ - Delete the symlink
template/{% if git_platform=="github.com" %}.github{% endif %}/pages - Delete
.github/workflows/_release.yml
The two CI failures are because the migration's step 2 created the pages-default-seed release and its tag is on main so git describe --tags now returns pages-default-seed. Copier writes that into _commit, and the CONTRIBUTING link is built from _commit.split('-')[0], so it becomes .../python-copier-template/pages/how-to.html, which 404s in linkcheck (test_template_defaults) and conflicts in test_example_repo_updates. The same tag push also ran the old docs workflow, so the live switcher.json now lists pages-default-seed as a version. I've raised DiamondLightSource/myst-version-switcher-plugin#83 so the seed tag stops landing on the default branch.
Step 2 also stopped at the Pages source flip with a 404, which is what you get without repo admin: Pages is still serving from gh-pages. Plan from here:
- @shree-iyengar-dls you now have admin, so please re-run
migrate.sh DiamondLightSource/python-copier-templateto finish step 2 (flip the Pages source to GitHub Actions). - Once the review comments are addressed, I'll merge this PR, accepting that these two tests stay red, since the seed has to stay until main builds its own docs.
- Run
migrate.sh DiamondLightSource/python-copier-template --delete-gh-pages, which deletesgh-pagesand the seed release, and CI goes green again.
Fixes #344 using the myst-version-switcher-plugin