Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable LFS #47

Merged
merged 4 commits into from
Jan 28, 2024
Merged

Enable LFS #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6d93a47
Enable LFS
purplg Dec 11, 2023
8beddb7
Add optional LFS variable
purplg Dec 16, 2023
216d5af
Updated README to include use_git_lfs release option
purplg Dec 17, 2023
e80d8fc
Added GitHub documentation quota links and warnings
purplg Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading