Skip to content

Delete leftover JLD2 files before deploying docs #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 9, 2019

Conversation

ali-ramadhan
Copy link
Member

Maybe not the cleanest solution but this will resolve #509 which has become a rather annoying issue recently.

@ali-ramadhan ali-ramadhan added the cleanup 🧹 Paying off technical debt label Dec 7, 2019
@ali-ramadhan
Copy link
Member Author

This PR should be merged first before to avoid any more JLD2 files being committed to git history.

@codecov
Copy link

codecov bot commented Dec 7, 2019

Codecov Report

Merging #558 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #558   +/-   ##
=======================================
  Coverage   67.72%   67.72%           
=======================================
  Files          69       69           
  Lines        1952     1952           
=======================================
  Hits         1322     1322           
  Misses        630      630

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a511fdd...b47e6bf. Read the comment docs.

Copy link
Member

@glwagner glwagner left a comment

Choose a reason for hiding this comment

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

Reluctant approval.

This is not a good solution, because its useful for users to have the JLD2 file around to play with.

We need to know why such behavior occurs so we can ensure it doesn't happen in the future --- how is the file being added from gh-pages, when jld2 is ignored in gitignore?

@ali-ramadhan
Copy link
Member Author

ali-ramadhan commented Dec 9, 2019

Actually I think I did it wrong in #524. I'm supposed to delete leftover files after makedocs but before deploydocs. So I'll modify this PR to do that.

I also feel that Documenter shouldn't even be adding jld2 files. Asking on Julia Slack to see if this is expected behavior and how to avoid it.

EDIT: There is no .gitignore file on gh-pages so we just have to add one there with *.jld2.

@ali-ramadhan ali-ramadhan changed the title Delete jld2 file after end of example Delete leftover JLD2 files before deploying docs Dec 9, 2019
@ali-ramadhan
Copy link
Member Author

I added a .gitignore to the gh-pages branch so we should be good now.

This PR now deletes leftover JLD2 files before deploying (just to be safe and also to unclutter the CI server in case we need to cache files between builds).

@ali-ramadhan ali-ramadhan merged commit 56b6956 into master Dec 9, 2019
@ali-ramadhan ali-ramadhan deleted the ali-ramadhan-patch-4 branch December 9, 2019 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup 🧹 Paying off technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Large JLD2 file has invaded our git history
2 participants