Jenkins multibranch pipeline 如何自动初始化并更新代码仓库的submodules

你需要实现的功能等效于执行以下两条Git命令：

git clone .
git submodule update --init --remote

可以通过两种方式实现，按需选择即可：

方案1：通过Git插件内置配置实现（无需修改Jenkinsfile，适配全分支） #

• 打开对应多分支流水线的配置页，定位到「分支源」分类下的Git仓库配置区域
• 点击「添加」按钮，选择「高级克隆行为」选项
• 依次勾选两个配置项：
  • 递归更新子模块
  • 更新子模块时使用--remote参数
• 保存配置后，后续所有分支的代码拉取环节都会自动执行子模块的初始化与远程更新操作

方案2：在Jenkinsfile中显式编写拉取逻辑（适合需要自定义子模块逻辑的场景） #

直接在代码拉取步骤后追加子模块更新命令即可，示例配置如下：

pipeline {
  agent any
  stages {
    stage('拉取代码') {
      steps {
        // 拉取当前仓库代码，scm为多分支流水线内置变量，自动适配当前分支配置
        checkout scm
        // 执行子模块初始化与远程更新命令
        sh 'git submodule update --init --remote'
      }
    }
    // 下方添加你的其余构建、测试、部署等流水线步骤
  }
}

注意：如果子模块属于私有仓库，需要确保Jenkins拉取代码所用的凭证，同时拥有所有子模块仓库的访问权限，否则会出现子模块拉取失败的问题。

内容的提问来源于stack exchange，提问作者Yuchen Wu