Skip to content

Remove documentation previews without rewriting gh-pages, and link them - #34

Merged
maleadt merged 2 commits into
mainfrom
tb/clear-preview
Oct 21, 2026
Merged

maleadt merged 2 commits into
mainfrom
tb/clear-preview

Conversation

@maleadt

@maleadt maleadt commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

The preview cleanup squashed gh-pages into a single commit and force-pushed it whenever a pull request closed, which races with documentation deploys that push to gh-pages at the same time. This replaces it with Documenter's ClearPreview.yml, the same workflow as in JuliaGPU/Metal.jl#1081 and JuliaGPU/CUDA.jl#3432: it deletes previews/PR<n> with a regular commit, and skips pull requests from forks.

It also comments once with a link to the preview on pull requests from this repository that change docs/, as Documenter only reports it as a commit status, which is easy to miss.

The cleanup workflow squashed gh-pages into a single commit and
force-pushed it every time a pull request closed, which races with
documentation deploys pushing to the same branch. Replace it with
Documenter's ClearPreview.yml, which only deletes the preview.
Documenter only reports the preview as a commit status, which is easy
to miss. Comment once with a link to it on pull requests that change
the documentation.
@maleadt maleadt changed the title Remove documentation previews without rewriting gh-pages Remove documentation previews without rewriting gh-pages, and link them Oct 20, 2026
@maleadt
maleadt merged commit b03368e into main Oct 21, 2026
10 checks passed
@maleadt
maleadt deleted the tb/clear-preview branch October 21, 2026 09:57
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