如何锁定声明性Jenkins管道的多个阶段？

我想在声明性Jenkins管道中的锁内运行多个阶段：

pipeline {
    agent any
    stages {
        lock(resource: 'myResource') {
            stage('Stage 1') {
                steps {
                  echo "my first step"
                }
            }

            stage('Stage 2') {
                steps {
                  echo "my second step"
                }
            }

        }
    }
}

我得到以下错误：

Started by user anonymous
org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
WorkflowScript: 10: Expected a stage @ line 10, column 9.
           lock(resource: 'myResource') {
           ^

WorkflowScript: 10: Stage does not have a name @ line 10, column 9.
           lock(resource: 'myResource') {
           ^

WorkflowScript: 10: Nothing to execute within stage "null" @ line 10, column 9.
           lock(resource: 'myResource') {
           ^

3 errors

    at org.codehaus.groovy.control.ErrorCollector.failIfErrors(ErrorCollector.java:310)
    at org.codehaus.groovy.control.CompilationUnit.applyToPrimaryClassNodes(CompilationUnit.java:1085)
    at org.codehaus.groovy.control.CompilationUnit.doPhaseOperation(CompilationUnit.java:603)
    at org.codehaus.groovy.control.CompilationUnit.processPhaseOperations(CompilationUnit.java:581)
    at org.codehaus.groovy.control.CompilationUnit.compile(CompilationUnit.java:558)
    at groovy.lang.GroovyClassLoader.doParseClass(GroovyClassLoader.java:298)
    at groovy.lang.GroovyClassLoader.parseClass(GroovyClassLoader.java:268)
    at groovy.lang.GroovyShell.parseClass(GroovyShell.java:688)
    at groovy.lang.GroovyShell.parse(GroovyShell.java:700)
    at org.jenkinsci.plugins.workflow.cps.CpsGroovyShell.reparse(CpsGroovyShell.java:116)
    at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.parseScript(CpsFlowExecution.java:430)
    at org.jenkinsci.plugins.workflow.cps.CpsFlowExecution.start(CpsFlowExecution.java:393)
    at org.jenkinsci.plugins.workflow.job.WorkflowRun.run(WorkflowRun.java:257)
    at hudson.model.ResourceController.execute(ResourceController.java:97)
    at hudson.model.Executor.run(Executor.java:405)
Finished: FAILURE

这里有什么问题？《公约》明确规定：

lock

还可用于将多个阶段包装到单个阶段中 并发单元

---

问题是，尽管事实上声明性管道是，但您引用的博客文章（从10月份开始）记录的是脚本化管道，而不是声明性的（它没有说那么多，所以我感觉到了您的痛苦）。可锁定资源还没有作为声明性管道步骤以启用您正在寻找的功能的方式加入

你可以做：

pipeline {
  agent { label 'docker' }
  stages {
    stage('one') {
      steps {
        lock('something') {
          echo 'stage one'
        }
      }
    }
  }
}

但你不能这样做：

pipeline {
  agent { label 'docker' }
  stages {
    lock('something') {
      stage('one') {
        steps {
          echo 'stage one'
        }
      }
      stage('two') {
        steps {
          echo 'stage two'
        }
      }
    }
  }
}

pipeline {
  agent { label 'docker' }
  stages {
    stage('one') {
      lock('something') {
        steps {
          echo 'stage one'
        }
      }
    }
  }
}

你不能这样做：

pipeline {
  agent { label 'docker' }
  stages {
    lock('something') {
      stage('one') {
        steps {
          echo 'stage one'
        }
      }
      stage('two') {
        steps {
          echo 'stage two'
        }
      }
    }
  }
}

pipeline {
  agent { label 'docker' }
  stages {
    stage('one') {
      lock('something') {
        steps {
          echo 'stage one'
        }
      }
    }
  }
}

---

您可以在此用例中使用脚本化管道。

应该注意，您可以使用锁定选项锁定管道中的所有阶段：

pipeline {
    agent any
    options {
        lock resource: 'shared_resource_lock'
    }
    stages {
        stage('will_already_be_locked') {
            steps {
                echo "I am locked before I enter the stage!"
            }
        }
        stage('will_also_be_locked') {
            steps {
                echo "I am still locked!"
            }
        }
    }
}

---

如果资源仅由此管道使用，则还可以禁用并发生成：

pipeline {
    agent any
    options {
        disableConcurrentBuilds()
    }
    stages {
        stage('will_already_be_locked') {
            steps {
                echo "I am locked before I enter the stage!"
            }
        }
        stage('will_also_be_locked') {
            steps {
                echo "I am still locked!"
            }
        }
   }
}

这个问题已经解决了

现在，您可以通过将多个阶段分组到父阶段来锁定它们，如下所示：

stage('Parent') {
  options {
    lock('something')
  }
  stages {
    stage('one') {
      ...
    }
    stage('two') {
      ...
    }
  }
}

---

（不要忘记您需要可锁定资源插件）

我在同一构建节点上运行多个构建和测试容器。测试容器必须将节点名称锁定为测试的db username

lock(resource: "${env.NODE_NAME}" as String, variable: 'DBUSER')

锁定选项是在加载时计算的，但节点名称在加载早期是未知的。为了锁定多个阶段以获得视觉效果，我们可以在脚本块内创建阶段，即代码段中的“运行测试”阶段。舞台可视化效果与其他舞台模块一样好

pipeline {
    agent any
    stages {
        stage('refresh') {
            steps {
                echo "freshing on $NODE_NAME"
                lock(resource: "${env.NODE_NAME}" as String, variable: 'DBUSER') {
                    sh '''
                        printenv | sort
                    '''
                    script {
                        stage('run test')
                        sh '''
                            printenv | sort
                        '''
                    }
                }
            }
        }
    }
}

---

问题仍然存在：请注意，锁定需要可锁定的资源插件：此批准的答案已过时。在当今世界，声明性管道的更好答案是below@JeffBennett是的，你是对的，这个答案是正确的，不再是最好的答案。上述jira问题已于2019年解决。您知道这是如何解决的吗？我只发现此PR[1]与另一个从未合并的PR重复关闭。我还找不到功能@JeffBennett是否有一个答案允许锁定某些而不是所有管道步骤？[1] 很好！我尝试了这个方法，但不幸的是，它不会阻止额外的管道构建占用执行器插槽，这正是我所需要的。此后，我用一个执行器插槽连接了一个本地构建代理，专门负责管道构建。我花了大量时间研究如何在多分支管道中阻止并发构建。这个简单的一行代码就是我要找的。这应该是不被认可的答案！棒极了的答案，三年后使用了这个，它完全符合我的需要。超级，工作起来很有魅力！嗨，Samuel，我无法使用声明性管道插件版本2.5（）。你们有什么版本？或者您正在使用脚本化管道？谢谢@gusgonnet I使其在声明性管道中工作，在Jenkins 2.121.2、管道2.5和可锁定资源2.3上工作得非常出色！我有一个并行阶段，我需要锁定整个集合。该解决方案不会阻止不同分支的构建