Hey there! Let's break down your questions about implementing stash_files and unstash_files in a Jenkins shared library, along with practical code implementations:

核心疑问解答 #

1. Stash是否仅能从工作区执行？ #

没错，Jenkins内置的stash命令只能操作当前节点的工作区文件。它的作用是把工作区内指定的文件/目录打包暂存，后续可以在同一次流水线的其他阶段或节点用unstash恢复使用。

2. 是否需要先将file.txt复制到工作区？ #

如果你的file.txt不在当前工作区内，那确实需要先把它复制到工作区才能被stash捕获。比如你从外部路径拉取或生成的文件，得先通过steps.copy或者sh 'cp /path/to/file.txt .'这类命令放到工作区根目录或子目录下。

共享库中stash/unstash方法的具体实现 #

你的共享库类需要持有Jenkins的steps对象（因为要调用流水线内置的stash/unstash步骤），下面是完整的可运行实现示例：

共享库代码（src/org/jenkins/Utils.groovy） #

package org.jenkins

class Utils implements Serializable {
    // 持有Jenkins steps对象，用于调用流水线内置步骤
    def steps

    // 构造方法，传入steps对象
    Utils(steps) {
        this.steps = steps
    }

    // 自定义stash_files方法：接收要暂存的文件路径和暂存名
    void stash_files(String filePath, String stashName) {
        // 可选：先检查文件是否在工作区存在，避免报错
        steps.sh "test -f ${filePath} || (echo 'Error: File ${filePath} not found in workspace!' && exit 1)"
        // 调用Jenkins内置stash步骤
        steps.stash(
            name: stashName,
            includes: filePath
            // 可选：如果需要排除某些文件，可添加excludes参数
            // excludes: '*.log'
        )
        steps.echo "✅ Successfully stashed file: ${filePath} (stash name: ${stashName})"
    }

    // 自定义unstash_files方法：接收暂存名，可选指定恢复路径
    void unstash_files(String stashName, String targetPath = '.') {
        // 切换到目标路径（如果指定了非工作区根目录）
        steps.dir(targetPath) {
            steps.unstash(stashName)
        }
        steps.echo "✅ Successfully unstashed stash: ${stashName} to path: ${targetPath}"
    }

    // 你原来的doit方法可以整合stash逻辑
    void doit(String filePath) {
        // 示例：如果文件不在工作区，先复制进来（根据你的实际场景调整）
        // steps.sh 'cp /external/storage/file.txt .'
        
        // 调用自定义stash方法，暂存到名为'fileStash'的暂存区
        stash_files(filePath, 'fileStash')
    }
}

Jenkinsfile调用示例 #

@Library('Utils') import org.jenkins.Utils
utils = new Utils(steps)

node() { 
    stage('Stash File'){ 
        // 确保file.txt在当前工作区，比如先拉取或生成
        // steps.sh 'wget https://example.com/file.txt'
        utils.doit("file.txt") 
    }

    stage('Unstash File'){
        // 在同一个节点或其他节点恢复暂存的文件到指定目录
        utils.unstash_files('fileStash', './restored_files')
    }
}

额外注意事项 #

• 序列化要求：共享库类必须实现Serializable，因为Jenkins流水线会在节点间序列化传递对象。
• 路径规则：stash的includes参数支持相对路径（相对于工作区根目录），如果是子目录下的文件，直接传src/file.txt这类路径即可。
• 跨节点使用：stash的暂存内容可以跨节点使用，只要是同一次流水线运行，在其他node块里调用unstash就能把文件恢复到该节点的工作区。

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