Skip to content

Fix docs deploy failing to push gh-pages on every release - #1709

Merged
collerek merged 1 commit into
masterfrom
fix/docs-deploy-gh-pages
Jun 8, 2026
Merged

Fix docs deploy failing to push gh-pages on every release#1709
collerek merged 1 commit into
masterfrom
fix/docs-deploy-gh-pages

Conversation

@collerek

@collerek collerek commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

The MkDocs/mike docs deploy has failed on every release since 0.21.0. The checkout is shallow and only fetches the pushed tag, so the origin/gh-pages remote-tracking ref never exists locally. mike's update_from_upstream() then no-ops, mike commits an orphan gh-pages, and the push is rejected as a non-fast-forward (! [rejected] gh-pages -> gh-pages (fetch first)).

Fetch gh-pages into the remote-tracking ref before mike deploy so it bases the new commit on the current docs and fast-forwards. Also adds a concurrency group to serialize deploys and replaces the invalid workflow_dispatch: tags: filter with a version input.

Takes effect for releases tagged after this merges; 0.26.0's docs (which never published) can then be deployed via Run workflow with version 0.26.0.

The docs deploy has failed on every release: the shallow tag-only checkout
leaves no origin/gh-pages remote-tracking ref, so mike's update_from_upstream
no-ops, mike commits an orphan gh-pages, and the push is rejected as a
non-fast-forward.

Fetch gh-pages into the remote-tracking ref before mike deploy so it bases the
new commit on the current docs and fast-forwards. Also serialize deploys with a
concurrency group and replace the invalid workflow_dispatch tags filter with a
version input so a release can be deployed manually.
@codspeed-hq

codspeed-hq Bot commented Jun 8, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 15.25%

⚡ 2 improved benchmarks
✅ 96 untouched benchmarks

Performance Changes

Mode Benchmark BASE HEAD Efficiency
WallTime test_updating_models_individually[20] 165.6 ms 137.8 ms +20.21%
WallTime test_get_column_name_from_alias[1000] 3.4 ms 3.1 ms +10.5%

Tip

Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.


Comparing fix/docs-deploy-gh-pages (259566b) with master (a7e7fde)

Open in CodSpeed

@collerek
collerek merged commit 6472f1f into master Jun 8, 2026
12 checks passed
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.

1 participant