NetLogo / NetLogo-Libraries

The central repository for the extensions listed in the NetLogo Extension Manager
15 stars 24 forks source link

How to handle large zip files (100mb+) #56

Open LaCuneta opened 2 years ago

LaCuneta commented 2 years ago

With recent updates to the Vid extension, the zip file size is over the 100mb limit for GitHub. GitHub advises using the git-lfs extension for this situation, which is an option for us. But I hesitated because it means anyone using or trying to contribute to this repository would have to also install that extension for their git client. For the Vid extension I decided just to put the zip file on our ccl-artifacts S3 bucket to avoid making a decision on this issue for now. Large extensions are pretty rare, as evidenced by the fact that this never came up before.

I see two options:

  1. Enable git-lfs and update instructions to include installing/using it. We should also test that the download links remain the same and are still usable by the extensions manager from NetLogo. This might be coupled with updated instructions for submitting extensions through the GitHub UI.
  2. Update the instructions to indicate files over 100mb must be uploaded elsewhere and a link provided with the pull request so we can download it and place it in our AWS bucket.

I should point out that using git-lfs might provide better performance for this repo in any case, as we do have many larger zip/binary files stored which is the use case for that extension, although none are over the size limit.