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.

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

Mark masonry/screenshots/*.png as LFS files #911

Merged
merged 1 commit into from
Mar 25, 2025
Merged

Conversation

PoignardAzur
Copy link
Contributor

These files we previously stored as blobs as-is. This stores them using the same LFS method as other screenshots.

@PoignardAzur
Copy link
Contributor Author

I'm wondering if there's any strong reason to have the pattern for LFS files be <some_path>/*.png and not just *.png.

Is there any case where we expect to add PNG images to the repo and not use LFS?

@DJMcNab
Copy link
Member

DJMcNab commented Mar 24, 2025

Test input data should not be stored in LFS; only the "canonical" outputs/results. That's because we're intentionally treating the LFS as a potentially fallible step, due to GitHub's weirdness around it (primarily the bandwidth limitation), but also in case we needed to move off GitHub.

That is, we need to be able to gracefully restore to a non-LFS state, even if we somehow lost access to all LFS files (unlikely for the up-to-date versions, but possible for historical ones).

Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a massive fan of storing screenshots in unique directories per module/group of modules. However, this change is accurate for the current state of the repository.

@PoignardAzur
Copy link
Contributor Author

Test input data should not be stored in LFS; only the "canonical" outputs/results.

Then how about something like **/screenshots/*.png? And document that pattern somewhere? (Maybe in ARCHITECTURE.md)

I'm not a massive fan of storing screenshots in unique directories per module/group of modules.

I doubt we'll ever get to a state where we have a single screenshot folder for the entire workspace. I'd expect at least each crate to have its own folder.

(Right now it's only masonry, but at some point it's probably going to be masonry_core, masonry and xilem.)

@PoignardAzur PoignardAzur added this pull request to the merge queue Mar 25, 2025
Merged via the queue into main with commit 3a21b21 Mar 25, 2025
18 checks passed
@PoignardAzur PoignardAzur deleted the fix_lfs_blobs branch March 25, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants