Jenkins 管道 git 命令子模块更新

Question

我想更新 git clone 上的子模块。

有没有办法使用 Jenkins 管道 Git 命令来做到这一点？

目前我正在这样做......

git branch: 'master',
    credentialsId: 'bitbucket',
    url: 'ssh://bitbucket.org/hello.git'

但是一旦克隆它就不会更新子模块

Answer 1

这与之前的答案略有不同，但我相信这是最好的解决方案。

我交换了分支参数以使用env.GIT_COMMIT，以便它检查已通过作业触发的特定提交。否则它将构建特定分支的最新提交，在其他示例中，当使用scm.branches 时，它将构建分支的尖端而不是预期的提交。

checkout([
    $class: 'GitSCM',
    branches: [[name: "${env.GIT_COMMIT}"]],
    doGenerateSubmoduleConfigurations: false,
    extensions: [[
        $class: 'SubmoduleOption',
        disableSubmodules: false,
        parentCredentials: true,
        recursiveSubmodules: true,
        reference: '',
        trackingSubmodules: false
    ]],
    submoduleCfg: [],
    userRemoteConfigs: scm.userRemoteConfigs
    ])

Answer 2

如果您知道 checkout scm 使用的凭证名称，您还可以将其显式传递给 git 命令以更新子模块：

    stage ('Clone') {
        steps {
            checkout scm
            withCredentials([sshUserPrivateKey(credentialsId: 'bitbucket_ssh', keyFileVariable: 'SSH_KEY')]) {
                sh 'GIT_SSH_COMMAND="ssh -i $SSH_KEY" git submodule update --init'
            }
        }
    }

Answer 3

checkout([
    $class: 'GitSCM', 
    branches: scm.branches, 
    doGenerateSubmoduleConfigurations: false, 
    extensions: [[
      $class: 'SubmoduleOption', 
      disableSubmodules: false, 
      parentCredentials: true, 
      recursiveSubmodules: true, 
      reference: '', 
      trackingSubmodules: false
    ]], 
    submoduleCfg: [], 
    userRemoteConfigs: scm.userRemoteConfigs
  ])

Answer 4

git command 作为管道步骤相当有限，因为它提供了更复杂的checkout command 的默认实现。对于更高级的配置，您应该使用checkout command，您可以为其传递大量参数，包括所需的子模块配置。

你想用的大概是这样的：

checkout([$class: 'GitSCM',
          branches: [[name: '*/master']],
          doGenerateSubmoduleConfigurations: false,
          extensions: [[$class: 'SubmoduleOption',
                        disableSubmodules: false,
                        parentCredentials: false,
                        recursiveSubmodules: true,
                        reference: '',
                        trackingSubmodules: false]], 
          submoduleCfg: [], 
          userRemoteConfigs: [[url: 'your-git-server/your-git-repository']]])

从文档来看，写这些行通常很麻烦，我建议你改用 Jenkins 非常好的 Snippet Generator (YourJenkins > yourProject > PipelineSyntax) 来自动生成结帐行！

Answer 5

使用当前的Git plugin，您甚至不需要它。

GIT 插件支持带有子模块的存储库，而这些子模块本身又具有子模块。
但这必须打开：

在作业配置 -> 部分源代码管理，Git -> 高级按钮（在要构建的分支下） -> 递归更新子模块

但是 OP 正在使用管道。

所以一个简单的第一个构建步骤就足够了：

git submodule update --init --recursive

但是，OP 补充说：

是的，但如果我使用sh 'git submodule update --init --recursive'，这将使用$HOME/id_rsa，对吗？如果可能的话，我想为这个命令传递我的私钥。

有可能：在Pipeline syntax，你可以define environment variables。
这意味着您可以设置GIT_SSH_COMMAND (with Git 2.10+)。
这样你就可以reference your own private key。

pipeline {
    agent any

    environment {
        GIT_SSH_COMMAND = 'ssh -i /path/to/my/private/key'
    }

    stages {
        stage('Build') {
            steps {
                sh 'printenv'
                sh 'git submodule update --init --recursive'
            }
        }
    }
} 

如果任何克隆涉及 ssh url，则该 ssh 克隆将使用正确的私钥。