[Chore] Very time-consuming when running git commit

[XinShuoWang]

Chore Type

Other

Task Description

I found that when I run the git commit command, it is very time-consuming. I used the time command to measure this time, and it was approximately 90s long.

wangxinshuo.db@localhost:/data00/home/wangxinshuo.db/bolt$ time git commit -m "fix"
..........................
..........................
..........................

real    1m19.610s
user    1m30.461s
sys     0m4.324s

Motivation / Benefit

Make git commit run faster to provide a better developer experience.

Related Files (Optional)

No response

Implementation Plan (Optional)

1. Only perform License checks on newly added files in pre-commit.
2. Perform License checks on all files in CI.

Additional Context

No response

[XinShuoWang]

@ZacBlanco What are your thoughts on this?

[ZacBlanco]

I originally tested running the license check only on staged/changed files, but the problem is that it doesn't take the ignored paths into account, meaning license check is applied incorrectly to some files. I'm not sure if there is any easy way around it. We could try to make another contribution to the license-eye tool to add a flag and change the behavior to make it compatible with pre-commit.

For the time being, I already made a contribution to the license-eye tool to run the check concurrently across multiple threads. This significantly speeds up the check time (from ~80s to ~15s on my machine). You can use the new version by replacing the pre-commit config block with the following:

  - repo: local
    hooks:
      -   id: license-header-check
          name: Check for license headers
          entry: license-eye header check
          language: golang
          pass_filenames: false
          additional_dependencies: ['github.com/apache/skywalking-eyes/cmd/license-eye@0630b017b4e34f27f0d8719c873d703fb31ec8de']
          args: ["-c", ".licenserc.yaml"]

I will keep this in the back of my mind, but the workaround above should drop the time enough to make git commit time reasonable for now. The update to the tool version will be introduced permanently once the following PR is merged: #120

[yangzhg]

@ZacBlanco @XinShuoWang

I've fixed the slow git commit issue by added a wrapper script to ensure our ignore rules in .licenserc.yaml still work correctly with this incremental mode. see #160