ci: Add pre-commit yaml configuration

[mishomihov00]

Description:

Add pre-commit yaml configuration for the pre-commit tool, which will run the spotlessApply gradle task.

Related issue(s):

Fixes #17223

Notes for reviewer:

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (be1981d)	96191	68558	71.27%
Head commit (13f7f9a)	96191 (+0)	68558 (+0)	71.27% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#17227)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.41%. Comparing base (be1981d) to head (13f7f9a).

Additional details and impacted files

@@            Coverage Diff            @@
##               main   #17227   +/-   ##
=========================================
  Coverage     67.41%   67.41%           
  Complexity    22063    22063           
=========================================
  Files          2585     2585           
  Lines         96408    96408           
  Branches      10071    10071           
=========================================
  Hits          64992    64992           
  Misses        27698    27698           
  Partials       3718     3718           

[nathanklick]

We should offer a pre-commit.yaml configuration instead of building a custom git hook.

[mishomihov00]

@nathanklick The idea here is to make it the same way as it is in hedera-mirror-node: https://github.com/hashgraph/hedera-mirror-node/blob/a6da57c2e94e65859a2c4e39cca0620836128cde/buildSrc/build.gradle.kts#L58

@mustafauzunn Can also provide more details if needed.

[rbarkerSL]

@nathanklick The idea here is to make it the same way as it is in hedera-mirror-node: https://github.com/hashgraph/hedera-mirror-node/blob/a6da57c2e94e65859a2c4e39cca0620836128cde/buildSrc/build.gradle.kts#L58

@mustafauzunn Can also provide more details if needed.

I think @nathanklick s point is that we shouldn't be modifying local commit history with this pre-commit hook. Offering the pre-commit yaml and the gradle task which already exists ./gradlew spotlessApply should be enough. And then the workflows will block any PR that fails spotless.

[jjohannes]

It would be good to reach some general agreement on how/if such a feature should exist in all Hedera repositories.

When we move MirrorNode to the shared Gradle configuration – hashgraph/hedera-mirror-node#10035 – the Gradle part has to be addressed. Either by removing the functionality or by adding something that works everywhere to the shared configuration.

My feeling is that it would be best to do this, if at all, without Gradle being involved in installing the hook. E.g., if some developers would like to use such a hook they can install it on their machine manually. And we just host the hook setup for calling spotlessApply (https://github.com/hashgraph/hedera-mirror-node/blob/a6da57c2e94e65859a2c4e39cca0620836128cde/buildSrc/src/main/resources/hooks/pre-commit) somewhere central for folks to use it if desired.