search

SimVascular / svFSIplus

svFSIplus is an open-source, parallel, finite element multi-physics solver.
https://simvascular.github.io/documentation/svfsi.html
Other
8 stars 23 forks source link

Add warning when adding git lfs-tracked files without git lfs #26

Open mrp089 opened 1 year ago

mrp089 commented 1 year ago

We use git lfs to store large files (.vtp, .vtu) which is set in .gitattributes. This is tracked automatically, so files added with git add get automatically tracked.

Unfortunately, developers must first install git lfs before using this feature. If a developer doesn't have git lfs installed and adds files with git add, it adds the actual (potentially large) files to the repository.

I'll add a tool to give a warning when a pull request gets opened that contains actual files that should be tracked with git lfs instead of their pointers. This should avoid adding large files to the repository

mrp089 commented 1 year ago

This is the tool: https://github.com/marketplace/actions/lfs-warning

mrp089 commented 1 year ago

I closed the pull request on this as it doesn't seem to work with a private repository. To be reopened when svFSIplus goes public

aabrown100-git commented 3 weeks ago

@mrp089 Our weekly issue-handling group came across this issue. Are you planning on trying again to resolve this issue? If it's not worth it, perhaps we can just make it extra clear in the documentation that you need to install git lfs.

mrp089 commented 2 weeks ago

I think you could try adding this tool now since it seems like the problem was that this repository wasn't public when I last tried it

aabrown100-git commented 2 weeks ago

When did the repo go public? It looks like your last attempt was January 24, 2024, which I thought was after the repo went public.

mrp089 commented 2 weeks ago

Ah, I didn't remember #170. You can add more documentation, but in the end, it comes down to the people merging a pull request to check if there are no large files committed to the repository. Fixing that retrospectively is extremely annoying (see #149), and it only gets worse the more people are using svFSIplus.