Jenkins中时间插件Build Timestamp Plugin怎么用

# Jenkins中时间插件Build Timestamp Plugin怎么用

## 一、插件简介

Build Timestamp Plugin是Jenkins中一个轻量级但非常实用的插件，它允许用户在构建过程中自定义时间戳格式，并将这些时间戳注入到构建环境变量中。主要功能包括：

- 为每次构建生成可定制格式的时间戳
- 支持将时间戳作为环境变量供后续步骤使用
- 兼容Freestyle和Pipeline项目
- 提供多种时间格式预设模板

## 二、安装步骤

1. **登录Jenkins管理后台**
   访问 `http://your-jenkins-server/pluginManager`

2. **搜索插件**
   在"Available"标签页搜索"Build Timestamp Plugin"

3. **安装插件**
   勾选插件后点击"Install without restart"

4. **验证安装**
   在"Installed"标签页确认插件状态为"Success"

## 三、基础配置

### 全局配置
1. 进入 `Manage Jenkins` → `Configure System`
2. 找到"Build Timestamp"区域
3. 配置默认格式（例如：`yyyy-MM-dd_HH-mm-ss`）
4. 可勾选"Use BUILD_TIMESTAMP as name"选项

### 常用时间格式符号
| 符号 | 含义          | 示例       |
|------|---------------|------------|
| yyyy | 4位年份       | 2023       |
| MM   | 2位月份       | 07         |
| dd   | 2位日期       | 15         |
| HH   | 24小时制小时  | 14         |
| mm   | 分钟          | 30         |
| ss   | 秒            | 45         |

## 四、在Freestyle项目中使用

1. **新建/编辑项目**
   进入项目配置页面

2. **启用时间戳**
   勾选"Use Build Timestamp"选项

3. **自定义格式**
   ```plaintext
   示例格式：yyyyMMdd-HHmmss
   生成结果：20230715-143045

1. 在构建步骤中引用
   • Windows批处理：echo %BUILD_TIMESTAMP%
   • Shell脚本：echo $BUILD_TIMESTAMP

五、在Pipeline项目中使用

声明式Pipeline示例

pipeline {
    agent any
    options {
        timestamps()  // 启用时间戳记录
        buildTimestamp('BUILD_TIMESTAMP', 'yyyyMMdd_HHmmss')
    }
    stages {
        stage('Example') {
            steps {
                sh 'echo $BUILD_TIMESTAMP > build_info.txt'
            }
        }
    }
}

脚本式Pipeline示例

node {
    // 设置时间戳格式
    def buildDate = new java.text.SimpleDateFormat("yyyy-MM-dd").format(new Date())
    
    stage('Build') {
        echo "Build started at ${buildDate}"
        // 其他构建步骤...
    }
}

六、高级用法

多时区支持

// 设置特定时区（如上海时区）
options {
    buildTimestamp('CST_TIMESTAMP', "yyyy-MM-dd HH:mm:ss z", 'Asia/Shanghai')
}

组合使用环境变量

environment {
    ARTIFACT_NAME = "app-${BUILD_TIMESTAMP}.zip"
}

邮件通知中使用

post {
    failure {
        emailext body: '构建失败时间: ${BUILD_TIMESTAMP}\n详情: ${BUILD_URL}'
    }
}

七、常见问题解决

1. 时间戳不生效

   • 检查插件是否已正确安装
   • 确认项目配置中已启用时间戳选项

2. 时区不正确

   • 在Jenkins系统配置中检查默认时区设置
   • 使用明确时区参数如Asia/Shanghai

3. 格式无效

   • 确保使用Java SimpleDateFormat支持的格式符号
   • 避免使用特殊字符作为分隔符

4. Pipeline中变量未解析

   • 在字符串中使用双引号而非单引号："${BUILD_TIMESTAMP}"
   • 检查变量作用域

八、最佳实践建议

1. 统一团队格式标准

   • 建议全项目使用统一的时间格式，如yyyyMMdd_HHmmss

2. 日志记录

   echo "Build started at ${currentBuild.startTimeInMillis}"
   

3. 与归档结合

   archiveArtifacts artifacts: "target/*-${BUILD_TIMESTAMP}.jar"
   

4. 定时任务增强

   triggers {
      cron('H 9-17 * * 1-5')
   }
   

通过合理使用Build Timestamp Plugin，可以显著提升构建日志的可读性和自动化流程的规范性。 “`