Jenkins ANSI Color Plugin 技术文档

1. 安装指南

使用插件管理器安装

1. 打开 Jenkins 控制台。
2. 导航到“系统管理” -> “插件管理”。
3. 在“可选插件”选项卡中搜索“AnsiColor”。
4. 选择插件并点击“安装”按钮。
5. 安装完成后，重启 Jenkins。

使用 Jenkins CLI 客户端安装

在命令行中执行以下命令：

java -jar jenkins-cli.jar install-plugin ansicolor

2. 项目的使用说明

在 Pipeline 中启用

使用 Build Wrapper

在 Pipeline 中启用 ansicolor 功能的最优方式是使用 Build Wrapper。这种方式可以为整个 Pipeline 的输出添加颜色。

示例：

pipeline {
    agent any
    options {
        ansiColor('xterm')
    }
    stages {
        stage('Build') {
            steps {
                echo '\033[34mHello\033[0m \033[33mcolorful\033[0m \033[35mworld!\033[0m'
            }
        }
    }
}

使用 Pipeline Step

你也可以使用 Pipeline Step 来启用 ansicolor 功能，这种方式适用于只需要部分输出着色的情况。

示例：

ansiColor('css') {
  sh "ls -al"
}

echo 'this will be rendered as-is'
// 支持在一个 Pipeline 中使用多个 ansiColor 步骤

ansiColor('vga') {
  echo '\033[42m\033[97mWhite letters, green background\033[0m'
}

在传统 Job 中启用

在传统 Jenkins UI 定义的 Job 中，可以通过“构建环境”设置启用 ansicolor 功能。

3. 项目 API 使用文档

ansiColor 函数

ansiColor 函数用于在 Pipeline 中启用 ANSI 颜色支持。函数接受一个参数，指定颜色映射。

参数

• xterm
• vga
• gnome-terminal
• css

示例：

ansiColor('xterm') {
  echo "TERM=${env.TERM}"
  // 输出 TERM=xterm
}

颜色映射

ansiColor 函数的参数定义了 Jenkins 应显示的颜色。具体颜色值在 AnsiColorMap.java 文件中定义。

4. 项目安装方式

使用插件管理器安装

通过 Jenkins 插件管理器安装 ansicolor 插件。

使用 Jenkins CLI 客户端安装

通过 Jenkins CLI 客户端命令行安装 ansicolor 插件。

5. 其他说明

颜色化 Ruby RSpec 输出

RSpec 格式化程序会检测 RSpec 是否在终端中运行，从而在 Jenkins 中抑制颜色输出。可以在调用 rspec 时指定 --colour --tty，或者将其添加到 .rspec 文件中。

支持的 ANSI 颜色代码和属性

插件支持大多数 ANSI 转义序列，包括：

• 属性：粗体、斜体、下划线、负片、隐藏、删除线、框架、上划线
• 标准文本颜色 30-37 和背景颜色 40-47
• 高强度文本颜色 90-97 和背景颜色 100-107（aixterm）
• xterm 256 颜色和 ISO-8613-3 24 位颜色（38 和 48）

不支持的属性：

• 微弱
• 闪烁
• 字体切换
• 环绕
• 表意字符属性 60-65

注意事项

• 如果你经常使用 Zsh 作为登录 shell，请注意 echo 命令支持字符转义，而 Bash 不支持。建议使用 printf 命令以确保在任何系统/shell 中都能正常工作。