BinaryFileNotTrackedByLfs
| Metadata | |
|---|---|
| Rule Id | BinaryFileNotTrackedByLfs |
| Priority | Warning |
| Available in | 0.7.0 or higher |
Cause¶
A binary file in the repository is not tracked by Git Large File Storage.
Rule description¶
By its nature Git repositories cannot handle binary files well and will keep a full copy of that file in the repository every time a change to that file is committed. Considering that you always clone the full history of a repository, and not only the latest version, using binary files in a repository considerably slow downs the operation. Git Large File Storage replaces large files with small text pointers inside the Git repository, while storing the file contents on a remote server.
Files marked as skip-worktree by Git, such as files omitted by sparse checkout, are excluded from this check because their working-tree contents are not available for binary-file detection. These files are still included in the file path length check.
Info
The rule assumes that all files, which are not text files are binary files. This also includes for example empty files.
How to fix violations¶
Track the file with Git Large File Storage.