gradle-wrapper.jar verification fails when stored via git-lfs

[LivingWithHippos]

If the jars are stored with git-lfs the checksum will fail, the lfs flag needs to be added

    steps:
      - uses: actions/checkout@v4
        with:
          lfs: true  # gradle-wrapper.jar verification will fail without this

otherwise there will be a mismatch, for example gradle 8.10

❯ sha256sum gradle-wrapper.jar
2db75c40782f5e8ba1fc278a5574bab070adccb2d21ca5a6e5ed840888448046  gradle-wrapper.jar

action error:

✗ Found unknown Gradle Wrapper JAR files:
 f629a612b54373f56f950e11394850bb65f87dd68d7731fcde2b99564dcfbf78 app/gradle/wrapper/gradle-wrapper.jar
Error: Error: At least one Gradle Wrapper Jar failed validation!

Not really a bug, posting this for reference. Maybe a check could be added to display a more useful error message?

[bigdaz]

Thanks for the report. We can at least update the documentation for this case.
A PR would be welcome :).

[bigdaz]

@LivingWithHippos Looking at the docs for actions/checkout, am I right in thinking that if you intend on running the Gradle build you would always need to add the lfs: true option?

It looks like the wrapper would fail to execute if you omit this option.

[LivingWithHippos]

If you set jars to be managed with git lfs in your repository gradle will always fail without that flag. It will compute the hash of the pointer files instead of the jars (I suppose)

[bigdaz]

Thanks. My point is that if someone is using setup-gradle with the automatic wrapper validation, then they are likely to already be including lfs: true in their workflow. Without this, any Gradle execution will fail, even without wrapper validation.

I wonder why lfs: false is the default for actions/checkout?

[bigdaz]

I've updated the documentation here: https://github.com/gradle/actions/blob/main/docs/wrapper-validation.md#wrapper-jar-stored-with-git-lfs.
Unless this issue becomes more widespread, I'm inclined to leave it at that.