Skip to content
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

Either document how to setup git-lfs, or get rid of it #118

Open
dellard opened this issue Aug 8, 2017 · 2 comments
Open

Either document how to setup git-lfs, or get rid of it #118

dellard opened this issue Aug 8, 2017 · 2 comments

Comments

@dellard
Copy link
Contributor

dellard commented Aug 8, 2017

The example test output files are represented in the git repo by references to git lfs objects. It doesn't look like this dependency is mentioned anywhere (or at least not blatantly enough to catch my eye), so my builds were failing.

I don't like adding dependencies (especially ones that aren't compatible with some platforms), and I don't know that we're benefitting from using git-lfs here anyway. I would recommend either getting rid of it (if that's possible), or at minimum adding documentation to the README.md explaining how to acquire, install, and use git-lfs correctly.

@grahamrow
Copy link
Member

I think documentation is the best short-term solution, but as long as our git clones don't become enormous we should consider alternatives.

@blakejohnson
Copy link
Collaborator

We are using Git LFS because it solves the problem that standard git is not good at tracking non-text files. Our tests depend on many 10s of MB of HDF5 files, which have changed several times over time. Using Git LFS keeps the primary git repo down to a manageable size.

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

No branches or pull requests

3 participants