Skip to content

Edit CI and docs to reflect generated archives not needing LFS #1365

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

Merged
merged 2 commits into from
May 8, 2024

Conversation

EliahKagan
Copy link
Member

Since 35439de (#1176), and as mentioned in #1334 (review) and #1360 (review), generated archives that formerly required Git LFS are now included in full as ordinary blobs in the gitoxide repository. Therefore:

  • The documentation changes that were part of #1360 are incomplete, because the explanation of why it is enough to let CI test changed fixture scripts on ubuntu-latest still gives the old reason related to Git LFS.
  • Documentation and CI workflows no longer need to use or mention Git LFS where the reason they had done so was related to fixtures.

The changes in this pull request address both those points.

LFS handling in tests/tools/src/lib.rs is intentionally retained, since there is no reason to remove LFS capabilities from the test tools (this could be revisited in the future if it is found to impose a significant maintenance burden) and LFS might potentially be used again in the future. Unlike in documentation and CI workflows, LFS capabilities in the test tools do not make working with the project any more complicated and do not make anything take longer.

I have also not made a change in .gitattributes. I'm unsure if any changes is needed or warranted there. The relevant line is:

https://github.com/Byron/gitoxide/blob/e791bc5da52a1237fb7cac230af583199162825d/.gitattributes#L1

I have permitted my editor to remove trailing whitespace, in files that I was editing anyway, since in all cases it appeared unintended. This deliberately does not remove trailing whitespace in files that would otherwise be untouched, nor does it do any other kind of cleanup.

EliahKagan added 2 commits May 7, 2024 21:56
This replaces the old reason why it's not necessry to test locally
on Linux-based systems with `GIX_TEST_IGNORE_ARCHIVES`, which has
not been current for quite some time since the generated archives
are no longer in LFS, with the current reason.

This builds on the documentation part of GitoxideLabs#1360.
This modifies the readme and one source code file to no longer say
that Git LFS is required to get generated archives, because they
are checked in as regular blobs instead these days, ever since
35439de (GitoxideLabs#1176). This may simplfy onboarding since readers are no
longer told they must do anything with `git lfs` to get started.

It also removes the LFS step from a CI test job definition that had
it, for the same reason: the generated archives are no longer
stored in LFS, so the only current expected effects of that step
are to make the job slightly more complicated and very slightly
slower. See also 7b3104d (GitoxideLabs#1360) and c60f270.
@EliahKagan EliahKagan marked this pull request as ready for review May 8, 2024 03:12
@Byron
Copy link
Member

Byron commented May 8, 2024

Thanks a lot, much appreciated!

I have also not made a change in .gitattributes. I'm unsure if any changes is needed or warranted there. The relevant line is:

I'd be glad to keep this line as well as a reminder of what once was. The reason for ditching LFS was my inability to fairly pay for it - all I needed was 1GB per month of bandwidth more, but was only able to purchase 50GB at a time, which would also not carry over between months.

@Byron Byron merged commit c4e0a82 into GitoxideLabs:main May 8, 2024
19 checks passed
@EliahKagan EliahKagan deleted the no-fixture-lfs branch May 8, 2024 07:10
@Skgland
Copy link

Skgland commented Jun 3, 2024

I don't believe this changes anything but GitHub is moving to metered billing for Git LFS , for now just Enterprises but all others are supposed to follow in the following months.

@Byron
Copy link
Member

Byron commented Jun 4, 2024

Thanks for sharing! It's great to see they are starting to make proper billing available so eventually this project can use that, too.

Just because git-lfs is perfect for this use-case - optional cache files that can accelerate test runs, but also are entirely optional in case git lfs isn't available on the client.

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.

None yet

3 participants