Skip to content

Fix Pages deploy: pin Jupyter Book to v1, modernize workflows - #117

Merged
will-fawcett-trillium merged 1 commit into
mainfrom
fix-pages-deploy
May 20, 2026
Merged

Fix Pages deploy: pin Jupyter Book to v1, modernize workflows#117
will-fawcett-trillium merged 1 commit into
mainfrom
fix-pages-deploy

Conversation

@will-fawcett-trillium

Copy link
Copy Markdown
Contributor

The deploy workflow silently stopped publishing the docs site. jupyter-book was unpinned in the docs extra, so it resolved to v2.x -- a MyST-engine rewrite that cannot build this repo's classic _config.yml / _toc.yml book. Under v2, jupyter-book build jupyterbook reads the directory as a file, errors, and still exits 0, so the build step went green while producing no HTML.

  • Pin jupyter-book<2 and drop the unused furo/nbsphinx/sphinx-copybutton from the docs extra; relock (jupyter-book 2.1.4 -> 1.0.4.post1).
  • Replace peaceiris/actions-gh-pages (no Node 24 release) with the official actions/upload-pages-artifact + actions/deploy-pages.
  • Bump actions/checkout v4 -> v6 and astral-sh/setup-uv v3 -> v8.1.0 in both workflows, clearing the Node 20 deprecation and the silently-ignored python-version input.
  • Add a build-output guard so an empty build fails loudly.

ghp-import and the Makefile publish-docs target are now redundant but left in place; they will be removed in a follow-up once this is verified live.

The deploy workflow silently stopped publishing the docs site. jupyter-book
was unpinned in the docs extra, so it resolved to v2.x -- a MyST-engine
rewrite that cannot build this repo's classic _config.yml / _toc.yml book.
Under v2, `jupyter-book build jupyterbook` reads the directory as a file,
errors, and still exits 0, so the build step went green while producing no
HTML.

- Pin jupyter-book<2 and drop the unused furo/nbsphinx/sphinx-copybutton
  from the docs extra; relock (jupyter-book 2.1.4 -> 1.0.4.post1).
- Replace peaceiris/actions-gh-pages (no Node 24 release) with the official
  actions/upload-pages-artifact + actions/deploy-pages.
- Bump actions/checkout v4 -> v6 and astral-sh/setup-uv v3 -> v8.1.0 in
  both workflows, clearing the Node 20 deprecation and the silently-ignored
  python-version input.
- Add a build-output guard so an empty build fails loudly.

ghp-import and the Makefile publish-docs target are now redundant but left
in place; they will be removed in a follow-up once this is verified live.

Deploying requires a one-time repo setting: Settings -> Pages -> Source =
"GitHub Actions".
@will-fawcett-trillium
will-fawcett-trillium merged commit 9884912 into main May 20, 2026
3 checks passed
@will-fawcett-trillium
will-fawcett-trillium deleted the fix-pages-deploy branch May 20, 2026 12:16
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.

2 participants