Add Doc Cleanup action & Show only latest docs#323
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an automated maintenance workflow for the gh-pages branch and updates Documenter deployment settings so that only the latest stable docs (plus dev) are shown in the version selector—reducing clutter and keeping the docs branch smaller over time.
Changes:
- Update
docs/make.jldeploydocsconfiguration to publish onlystableanddevversions. - Add a scheduled/manual “Doc Cleanup” GitHub Actions workflow to delete old versioned docs directories and rewrite
gh-pageshistory.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/make.jl |
Adjusts deploydocs version selector to show only latest stable and dev docs. |
.github/workflows/DocCleanup.yml |
Introduces scheduled/manual cleanup of old docs versions on gh-pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #323 +/- ##
=======================================
Coverage 98.33% 98.33%
=======================================
Files 51 51
Lines 1442 1442
=======================================
Hits 1418 1418
Misses 24 24 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| keep="$(readlink stable)" | ||
| git config user.name "Documenter.jl" | ||
| git config user.email "documenter@juliadocs.github.io" | ||
| git rm -rf --ignore-unmatch v[0-9]*.[0-9]* | ||
| git checkout HEAD -- "$keep" |
There was a problem hiding this comment.
@juliohm, this suggestion isn't strictly necessary, since the stable symlink will always exist in the documentation generated by Documenter.jl.
|
Thank you @eliascarv for looking into it. So the build failure is caused by memory blow ups on GitHub again? I find it surprising that Documenter.jl's + GitHub Actions default behavior leads to this. Are we overlooking something maybe? Should we also create a TableTransformsDocs repo to avoid blowing this repo with large commit history as well? |
|
@juliohm I don't think so, since TableTransforms.jl doesn't have such extensive documentation, nor does it release as many versions as Meshes.jl and GeoStats.jl. |
|
Why are we adding a DocCleanup action here? Sorry I didn't have time to
dive into the root of the issue. I understand that you're cleaning up the
docs to fix the doc build on github?
Em ter., 23 de jun. de 2026, 10:07, Elias Carvalho ***@***.***>
escreveu:
… *eliascarv* left a comment (JuliaML/TableTransforms.jl#323)
<#323 (comment)>
@juliohm <https://github.com/juliohm> I don't think so, since
TableTransforms.jl doesn't have such extensive documentation, nor does it
release as many versions as Meshes.jl and GeoStats.jl.
—
Reply to this email directly, view it on GitHub
<#323?email_source=notifications&email_token=AAZQW3NAJMYLLHHGBE533S35BJ6H7A5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTINZXHE2TCMZTGQ3KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#issuecomment-4779513346>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAZQW3MSVBPCTCPYAD5CFX35BJ6H7AVCNFSNUABFKJSXA33TNF2G64TZHM2DEMJUGAZDAOBVHNEXG43VMU5TINZSGU3TQMRWGQY2C5QC>
.
Triage notifications, keep track of coding agent tasks and review pull
requests on the go with GitHub Mobile for iOS
<https://github.com/notifications/mobile/ios/AAZQW3JLUZXBW5BCHFCRSLL5BJ6H7A5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTINZXHE2TCMZTGQ3KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJKTGN5XXIZLSL5UW64Y>
and Android
<https://github.com/notifications/mobile/android/AAZQW3KZ2I4CBKRPE5ULG5T5BJ6H7A5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTINZXHE2TCMZTGQ3KM4TFMFZW63VHNVSW45DJN5XKKZLWMVXHJLTGN5XXIZLSL5QW4ZDSN5UWI>.
Download it today!
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
@juliohm yes, the |
This PR adds the Doc Cleanup action to clean up old documentation versions, just as is done in MeshesDocs and GeoStatsDocs.
It also modifies make.jl to show only the latest version of the documentation.
The action will run on the 1st of the month at 3:00 UTC, as this is a time of lower computational load for GitHub's servers.
The action can also be triggered manually, when necessary.
Fix #322