在管道执行期间从 Jenkins 管道 UI 编辑文件

Question

我们需要允许在管道执行期间编辑文件。该文件需要从 Jenkins UI 修改。

我们知道我们可以在管道阶段接受变量输入。在继续下一阶段之前，我们需要以相同的方式从 Jenkins UI 编辑文件。

Answer 1

您可以在 Jenkins 管道脚本中使用“输入”步骤。此步骤会暂停管道并等待人工输入，然后再进入下一阶段。

pipeline {
    agent any
    
    stages {
        stage('Edit File') {
            steps {
                // Display a message indicating the need to edit the file
                echo 'Please edit the file below:'
                
                // Use the input step to wait for user input
                input message: 'Edit the file', ok: 'Proceed'
            }
        }
        stage('Next Stage') {
            steps {
                // Add steps for the next stage of the pipeline
            }
        }
    }
}

当管道到达“编辑文件”阶段时，它将暂停并在 Jenkins UI 中显示一条消息，指示用户编辑文件。用户进行必要的编辑并单击 UI 中的“继续”后，管道将继续进入下一阶段。

注意：您可以进一步调整适合您特定要求的内容，例如指定要编辑的文件或向用户提供其他说明。此外，您可能需要添加错误处理或验证，以确保在继续管道的下一阶段之前正确编辑文件。

Answer 2

你可以做如下的事情，但它不会很漂亮。

    stage('Results') {
        
        def filePath = '/path/to/file.txt'
        def fileOrigContent = readFile(filePath)
        def userInput = input(id: 'fileContent', message: 'Edit the content below:',
                            parameters: [string(defaultValue: fileOrigContent, description: 'File content', name: 'Filecontent')
                            ])
        
        writeFile(file: filePath, text: userInput, encoding: "UTF-8")
    }