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

Jump to bottom

Improve documentation around how to use git lfs #5526

Open
emilk opened this issue Dec 28, 2024 · 3 comments · May be fixed by #5707
Open

Improve documentation around how to use git lfs #5526

emilk opened this issue Dec 28, 2024 · 3 comments · May be fixed by #5707
Assignees
@lucasmerlin
Labels
docs and examples Improving and adding documentation and examples

Comments

@emilk
Copy link
Owner

emilk commented Dec 28, 2024

We mandate that png images are put on git lfs, and have a CI job to check it. However, we lack clear instructions of how to:

  • Add a file to git lfs
  • Move a file from "normal" git to lfs
  • Move a file from lfs to "normal" git

We should add such instructions to CONTRIBUTING.md and link to it from .github/workflows/png_only_on_lfs.yml (make error messages actionable)
@emilk emilk added the docs and examples Improving and adding documentation and examples label Dec 28, 2024
@emilk emilk added this to egui Dec 28, 2024
@emilk emilk moved this to Next up in egui Dec 28, 2024
@emilk emilk mentioned this issue Dec 28, 2024
Merged
1 task
@emilk
Copy link
Owner Author

emilk commented Jan 2, 2025

There also seems to be a problem adding commits to user PRs if any of the commits touches git lfs. This is very annoying, and I wonder if there is some way around it.

@emilk
Copy link
Owner Author

emilk commented Jan 31, 2025

There is a way around it!

When pushing to a contributor remote, you need to do git push --no-verify to circumvent git lfs.

@lucasmerlin
Copy link
Collaborator

lucasmerlin commented Feb 10, 2025 •
edited
Loading

git push --no-verify

Does that mean that we can't push lfs files to contributor remotes?

@lucasmerlin lucasmerlin self-assigned this Feb 10, 2025
@lucasmerlin lucasmerlin moved this from Next up to In progress in egui Feb 10, 2025
@lucasmerlin lucasmerlin moved this from In progress to In review in egui Feb 10, 2025
@lucasmerlin lucasmerlin linked a pull request Feb 10, 2025 that will close this issue
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lucasmerlin lucasmerlin

Labels
docs and examples Improving and adding documentation and examples
Projects
egui
Status: In review
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improved git lfs instructions emilk/egui
2 participants
@emilk @lucasmerlin