From 6d93a4782111f4c302609f1f9faa2141fe2fcc5b Mon Sep 17 00:00:00 2001 From: Ben Whitley Date: Sun, 10 Dec 2023 20:06:03 -0500 Subject: [PATCH 1/4] Enable LFS --- .github/workflows/release.yaml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 089b7fb..508b54b 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -22,6 +22,8 @@ jobs: - uses: olegtarasov/get-tag@v2.1.2 id: get_version - uses: actions/checkout@v4 + with: + lfs: true - uses: dtolnay/rust-toolchain@stable with: targets: wasm32-unknown-unknown @@ -68,6 +70,8 @@ jobs: - uses: olegtarasov/get-tag@v2.1.2 id: get_version - uses: actions/checkout@v4 + with: + lfs: true - uses: dtolnay/rust-toolchain@stable with: targets: x86_64-unknown-linux-gnu @@ -115,6 +119,8 @@ jobs: - uses: olegtarasov/get-tag@v2.1.2 id: get_version - uses: actions/checkout@v4 + with: + lfs: true - uses: dtolnay/rust-toolchain@stable with: targets: x86_64-pc-windows-msvc @@ -158,6 +164,8 @@ jobs: - uses: olegtarasov/get-tag@v2.1.2 id: get_version - uses: actions/checkout@v4 + with: + lfs: true - uses: dtolnay/rust-toolchain@stable with: targets: x86_64-apple-darwin @@ -202,6 +210,8 @@ jobs: - uses: olegtarasov/get-tag@v2.1.2 id: get_version - uses: actions/checkout@v4 + with: + lfs: true - uses: dtolnay/rust-toolchain@stable with: targets: aarch64-apple-darwin From 8beddb79f4a72bd3d9670d98f8192b8022f46773 Mon Sep 17 00:00:00 2001 From: Ben Whitley Date: Sat, 16 Dec 2023 18:42:08 -0500 Subject: [PATCH 2/4] Add optional LFS variable --- .github/workflows/release.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 508b54b..abadf20 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -9,6 +9,7 @@ env: # update with the name of the main binary binary: bevy_github_ci_template add_binaries_to_github_release: true + use_git_lfs: false #itch_target: / @@ -23,7 +24,7 @@ jobs: id: get_version - uses: actions/checkout@v4 with: - lfs: true + lfs: ${{ env.use_git_lfs }} - uses: dtolnay/rust-toolchain@stable with: targets: wasm32-unknown-unknown @@ -71,7 +72,7 @@ jobs: id: get_version - uses: actions/checkout@v4 with: - lfs: true + lfs: ${{ env.use_git_lfs }} - uses: dtolnay/rust-toolchain@stable with: targets: x86_64-unknown-linux-gnu @@ -120,7 +121,7 @@ jobs: id: get_version - uses: actions/checkout@v4 with: - lfs: true + lfs: ${{ env.use_git_lfs }} - uses: dtolnay/rust-toolchain@stable with: targets: x86_64-pc-windows-msvc @@ -165,7 +166,7 @@ jobs: id: get_version - uses: actions/checkout@v4 with: - lfs: true + lfs: ${{ env.use_git_lfs }} - uses: dtolnay/rust-toolchain@stable with: targets: x86_64-apple-darwin @@ -211,7 +212,7 @@ jobs: id: get_version - uses: actions/checkout@v4 with: - lfs: true + lfs: ${{ env.use_git_lfs }} - uses: dtolnay/rust-toolchain@stable with: targets: aarch64-apple-darwin From 216d5af1d1c4918e8b0092027c737bf8355662b5 Mon Sep 17 00:00:00 2001 From: Ben Whitley Date: Sat, 16 Dec 2023 19:55:54 -0500 Subject: [PATCH 3/4] Updated README to include use_git_lfs release option --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c963b8e..289c634 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ 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. + ### 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) From e80d8fc01d2686f07d35a6237993fe0f8d3aeec3 Mon Sep 17 00:00:00 2001 From: Ben Whitley Date: Sat, 27 Jan 2024 17:41:36 -0500 Subject: [PATCH 4/4] Added GitHub documentation quota links and warnings --- .github/workflows/release.yaml | 5 ++++- README.md | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index abadf20..6c5813e 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -9,9 +9,12 @@ env: # update with the name of the main binary binary: bevy_github_ci_template add_binaries_to_github_release: true - use_git_lfs: false #itch_target: / + # 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: diff --git a/README.md b/README.md index 289c634..2c4095d 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,9 @@ If you don't want to attach the builds to the GitHub release, set `env.add_binar 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)