Jenkins共享库中用Groovy实现自定义命名步骤及输出静默

嘿，我刚好在Jenkins共享库上折腾过类似的需求，给你分享下可行的方案！

你说嵌套stage没用，那试试用Jenkins原生支持的控制台输出折叠标记，这个在Blue Ocean和原生控制台里都会生效，完全不需要写插件，纯共享库就能实现。

核心思路是写一个自定义函数，接受块名称和要执行的闭包，在闭包执行前后输出特定标记，让Jenkins把中间的输出包裹成可折叠的块。具体实现如下：

在共享库的vars/customBlock.groovy文件中编写：

def call(String blockName, Closure body) {
    // 输出折叠开始标记（GitHub风格，Jenkins原生识别）
    echo "::group::${blockName}"
    try {
        // 执行用户传入的闭包内容
        body()
    } finally {
        // 无论成功失败都输出折叠结束标记，避免输出截断
        echo "::endgroup::"
    }
}

之后在你的Pipeline里就能像调用sh一样使用这个块：

@Library('your-shared-lib') _

pipeline {
    agent any
    stages {
        stage('Demo Custom Block') {
            steps {
                script {
                    customBlock('构建项目') {
                        sh 'mvn clean package'
                        sh 'echo 构建产物路径：target/*.jar'
                    }

                    customBlock('部署前置检查') {
                        sh 'kubectl get namespaces'
                    }
                }
            }
        }
    }
}

这样在Blue Ocean里，每个customBlock的内容都会被折叠成带名称的可展开块，原生控制台也支持手动展开/收起，比嵌套stage灵活太多。如果想要更直观的视觉区分，还可以结合ansiColor插件给块名称加颜色：

echo "\033[34m::group::${blockName}\033[0m"

这个有两种实用方式，都可以封装成共享库函数复用：

方式一：直接重定向输出 #

最朴素的方法是把命令的标准输出和错误输出都重定向到黑洞：

// Linux/macOS
sh 'your-unwanted-command > /dev/null 2>&1'
// Windows节点
sh 'your-unwanted-command > NUL 2>&1'

方式二：共享库封装静默sh函数 #

在共享库vars/silentSh.groovy里写：

def call(String command) {
    // 捕获输出但不打印，同时返回命令退出码（避免失败直接中止流水线）
    def exitCode = sh(script: command, returnStdout: true, returnStatus: true)
    // 如果需要在命令失败时抛出错误，可添加判断
    if (exitCode != 0) {
        error "静默执行命令失败：${command}"
    }
}

这样调用silentSh('rm -rf temp-files')时，命令的输出不会出现在控制台，但如果命令出错，会抛出明确的错误信息。

比如你需要：执行带有效输出的命令 → 静默无关操作 → 输出成功提示，用共享库可以这么写：

@Library('your-shared-lib') _

pipeline {
    agent any
    stages {
        stage('Demo Workflow') {
            steps {
                script {
                    customBlock('生成核心输出') {
                        sh 'echo 当前版本号：v$(cat VERSION)'
                    }

                    // 静默执行清理、校验等无关命令
                    silentSh('rm -rf build-temp')
                    silentSh('echo 这条输出会被完全隐藏')

                    echo "✅ 所有步骤执行成功！"
                }
            }
        }
    }
}

运行后，控制台和Blue Ocean只会显示折叠的核心输出块、最后的成功提示，中间的静默命令不会产生任何冗余输出。

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