feat(util/git): support checkout depth in submodules

[squat]

This commit adds support for configuring the checkout depth of
submodules. The simple approach here in this PR is to use the global
depth configured for the repository for the submodule.
In my opinion, this is the most logical way to treat the current
configuration surface, which only exposes a single field to configure
the checkout depth of a monorepo. Rather than add more knobs to tune
the checkout depth of every single different submodule in a repo, this
commit takes the simple approach of applying the depth globally to all
submodules.

The commit introduces new unit tests to validate that shallow checkouts
work for submodules.

Fixes: #26774

Signed-off-by: squat lserven@gmail.com

[bunnyshell]

❗ Preview Environment deployment failed on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

• 🚀 /bns:deploy to redeploy the environment
• ❌ /bns:delete to remove the environment

[squat]

I'm pretty sure the failure in the unit test is a flake because the test is timing out while trying to clone from github; this is likely hitting network issues or rate limits.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.05%. Comparing base (63a009e) to head (40cf85e).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #26777      +/-   ##
==========================================
+ Coverage   63.04%   63.05%   +0.01%     
==========================================
  Files         414      414              
  Lines       56286    56294       +8     
==========================================
+ Hits        35484    35496      +12     
  Misses      17427    17427              
+ Partials     3375     3371       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[olivergondza]

@squat, I like the idea of propagating the git --depth into submodules.

Have you considered refactoring the depth into one of the client options (would require changing Fetch(revision string, depth int64)), so it does not have to be passed over and over through several client methods? It is configured per-repository anyway...

[choejwoo]

+1 to @olivergondza suggestion.
Would it be cleaner to make depth a client option, since it is repo-level config, instead of threading it through multiple methods?

[squat]

@olivergondza @choejwoo thanks for taking a look at this changeset! On the subject of the specifying the clone depth for the client, agreed, I think that setting the depth once as an option on the nativeGitClient struct is cleaner and less repetitive. I just pushed a new commit to incorporate that suggestions and the result is indeed much cleaner. PTAL when you can!

[olivergondza]

Perfect, looks nicer!