Enable LFS (#47)

* Enable LFS

* Add optional LFS variable

* Updated README to include use_git_lfs release option

* Added GitHub documentation quota links and warnings

Author: purplg

.github/workflows/release.yaml

@@ -11,6 +11,10 @@ env:
   add_binaries_to_github_release: true
   #itch_target: <itch.io-username>/<game-name>
 
+  # Before enabling LFS, please take a look at GitHub's documentation for costs and quota limits:
+  # https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage
+  use_git_lfs: false
+
 
 jobs:
 
@@ -22,6 +26,8 @@ jobs:
       - uses: olegtarasov/[email protected]
         id: get_version
       - uses: actions/checkout@v4
+        with:
+          lfs: ${{ env.use_git_lfs }}
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: wasm32-unknown-unknown
@@ -68,6 +74,8 @@ jobs:
       - uses: olegtarasov/[email protected]
         id: get_version
       - uses: actions/checkout@v4
+        with:
+          lfs: ${{ env.use_git_lfs }}
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: x86_64-unknown-linux-gnu
@@ -115,6 +123,8 @@ jobs:
       - uses: olegtarasov/[email protected]
         id: get_version
       - uses: actions/checkout@v4
+        with:
+          lfs: ${{ env.use_git_lfs }}
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: x86_64-pc-windows-msvc
@@ -158,6 +168,8 @@ jobs:
       - uses: olegtarasov/[email protected]
         id: get_version
       - uses: actions/checkout@v4
+        with:
+          lfs: ${{ env.use_git_lfs }}
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: x86_64-apple-darwin
@@ -202,6 +214,8 @@ jobs:
       - uses: olegtarasov/[email protected]
         id: get_version
       - uses: actions/checkout@v4
+        with:
+          lfs: ${{ env.use_git_lfs }}
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: aarch64-apple-darwin

README.md

@@ -36,6 +36,11 @@ If you don't want to target some of those platforms, you can remove the correspo
 
 If you don't want to attach the builds to the GitHub release, set `env.add_binaries_to_github_release` to `false`.
 
+If you are using Git LFS, set `env.use_git_lfs` to `true` so your assets are properly checked out.
+
+> [!Warning]
+> GitHub's LFS storage has a quota. Please take a look at GitHub's documentation [here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage) to understand the quota and costs before enabling this option.
+
 ### Git Tag from GitHub UI
 
 You can follow [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)