Skip to content

Commit

Permalink
Added GitHub documentation quota links and warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
purplg committed Jan 27, 2024
1 parent 216d5af commit e80d8fc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: <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 Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit e80d8fc

Please sign in to comment.