Skip to content

ci: update docs publishing using myst-version-switcher-plugin - #373

Open
shree-iyengar-dls wants to merge 38 commits into
mainfrom
344_change_docs_publishing_ci
Open

shree-iyengar-dls wants to merge 38 commits into
mainfrom
344_change_docs_publishing_ci

Conversation

@shree-iyengar-dls

Copy link
Copy Markdown
Collaborator

@shree-iyengar-dls
shree-iyengar-dls marked this pull request as ready for review October 7, 2026 14:37
@ZohebShaikh

Copy link
Copy Markdown
Contributor

@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

@shree-iyengar-dls

shree-iyengar-dls commented Nov 2, 2026 •

Copy link
Copy Markdown
Collaborator Author

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:

-- 2. Flipping Pages source → GitHub Actions -- (gh-pages still exists after this and is the rollback: set the source back to 'Deploy from a branch' to restore serving with no data lost.) { "message": "Not Found", "documentation_url": "https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site", "status": "404" }

The GitHub Actions also seems to have failed.

shree-iyengar-dls and others added 9 commits November 2, 2026 10:00
@OCopping
OCopping force-pushed the 344_change_docs_publishing_ci branch from faa8237 to 663b651 Compare November 2, 2026 10:08

@coretl coretl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. @shree-iyengar-dls you now have admin, so please re-run migrate.sh DiamondLightSource/python-copier-template to finish step 2 (flip the Pages source to GitHub Actions).
  2. 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.
  3. Run migrate.sh DiamondLightSource/python-copier-template --delete-gh-pages, which deletes gh-pages and the seed release, and CI goes green again.

Comment thread template/pyproject.toml.jinja Resolved
Comment thread docs/how-to/build-docs.md Resolved
Comment thread docs/how-to/build-docs.md Resolved
Comment thread template/renovate.json.jinja Resolved

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Change CI such that Docs are no longer published to gh-pages

5 participants