Skip to content

Add Doc Cleanup action & Show only latest docs#323

Merged
juliohm merged 4 commits into
masterfrom
doc-cleanup
Jun 23, 2026
Merged

Add Doc Cleanup action & Show only latest docs#323
juliohm merged 4 commits into
masterfrom
doc-cleanup

Conversation

@eliascarv

Copy link
Copy Markdown
Member

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

Copilot AI 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.

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.jl deploydocs configuration to publish only stable and dev versions.
  • Add a scheduled/manual “Doc Cleanup” GitHub Actions workflow to delete old versioned docs directories and rewrite gh-pages history.

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.

Comment thread .github/workflows/DocCleanup.yml Outdated
Comment thread .github/workflows/DocCleanup.yml
@codecov-commenter

codecov-commenter commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.33%. Comparing base (3c9fea3) to head (cea597d).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI 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.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread .github/workflows/DocCleanup.yml Outdated
eliascarv and others added 2 commits June 23, 2026 09:35
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI 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.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment on lines +19 to +23
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"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@juliohm, this suggestion isn't strictly necessary, since the stable symlink will always exist in the documentation generated by Documenter.jl.

@juliohm

juliohm commented Jun 23, 2026

Copy link
Copy Markdown
Member

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?

@eliascarv

Copy link
Copy Markdown
Member Author

@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.

@juliohm

juliohm commented Jun 23, 2026 via email

Copy link
Copy Markdown
Member

@eliascarv

Copy link
Copy Markdown
Member Author

@juliohm yes, the gh-pages branch has accumulated many versions of the documentation. This action will simply automate the cleanup to avoid storage errors in the repository. It probably only needs to run once a year, but I set it to run once a month to keep the repository lightweight.

@juliohm juliohm merged commit 50cfaf3 into master Jun 23, 2026
9 checks passed
@juliohm juliohm deleted the doc-cleanup branch June 23, 2026 15:22
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.

Fix documentation build

4 participants