search

ros-sports / soccer_interfaces

A set of packages which contain common soccer interface files
Apache License 2.0
8 stars 3 forks source link

Having images in the repository will blow up the size of the repo (and it's history) #19

Closed ijnek closed 2 years ago

ijnek commented 2 years ago

Must upload images elsewhere, or setup a docs repository to store the images.

Flova commented 2 years ago

Afaik if you paste an image in the GitHub Markdown editor it gets stored on a GitHub CDN and linked.

ijnek commented 2 years ago

When using the markdown editor, that would work, but not being able to edit the README locally isn't ideal.

If storing all images in the git repo, my concern isn't much that the files itself take up space, but that the initial clone can take a huge amount of time, as every version of every file has to be downloaded by the client.

Old images that have been modified / removed have to be stored in the git repo. Using git clone --depth 1 is a work-around but is definitely not a solution.

I'm thinking of using Git LFS such that all the copies of the images don't have to be stored. Perhaps, I might rewrite history to reduce the current repo size.

Does this sound reasonable @Flova ?

ijnek commented 2 years ago

Git LFS seems to have it's own limitations, like a monthly bandwidth quota of 1 GB, decided that moving to rtd is better in long term.