Shallow git submodule checkout using Jenkins

Question

I have no problem doing this using git commands, as in Set Git submodule to shallow clone & sparse checkout? but I have a project using Jenkins and I'm using the checkout() function in the Groovy Pipeline syntax. I can't find any option to pass the --depth option to the git submodule update commands.

Answer 1

You should be able to use the extensions parameter in the checkout step:

checkout([
  $class: 'GitSCM', 
  branches: [[name: 'master']], 
  doGenerateSubmoduleConfigurations: false, 
  extensions: [[$class: 'CloneOption', depth: 0, noTags: false, reference: '', shallow: true]],
  submoduleCfg: [], 
  userRemoteConfigs: [[url: '[email protected]:repo/repo.git']]])

If you are using the snippet generator, select Additional Behaviors -> Advanced clone behaviors to see the different options. Hope that helps!