Jenkins构建脚本Ubuntu编写规范

以下是在Ubuntu上编写Jenkins构建脚本的规范要点，基于Jenkins Pipeline（推荐使用声明式语法）：

一、环境准备

1. 安装Jenkins
   通过命令行安装Jenkins及Java依赖，确保版本兼容：

   sudo apt update
   sudo apt install openjdk-11-jdk
   wget -q -O - https://pkg.jenkins.io/debian/jenkins.io.key | sudo apt-key add -
   sudo sh -c 'echo deb http://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list'
   sudo apt update
   sudo apt install jenkins
   sudo systemctl start jenkins
   sudo systemctl enable jenkins
   

2. 配置基础环境

   • 安装项目所需工具（如Maven、Node.js等）：

     sudo apt install maven nodejs npm  # 根据项目类型选择
     

   • 配置SSH密钥（用于远程部署）：

     ssh-keygen -t rsa -b 4096 -C "[e-mail]"
     cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
     

二、脚本编写规范

1. 推荐使用声明式Pipeline（Jenkinsfile）

• 文件位置：项目根目录下创建Jenkinsfile，与代码一同版本化。
• 基础结构：

  pipeline {
      agent any  // 指定执行节点，如 'label: ubuntu-server'
      environment {
          // 定义环境变量，避免硬编码敏感信息
          API_KEY = credentials('api-key-secret') 
      }
      stages {
          stage('Checkout') {
              steps {
                  git branch: 'main', url: 'https://github.com/your/repo.git'
              }
          }
          stage('Build') {
              steps {
                  sh 'mvn clean package'  // Maven项目
                  // 或 sh 'npm install && npm run build'  // 前端项目
              }
          }
          stage('Test') {
              steps {
                  junit 'target/surefire-reports/*.xml'  // 测试报告
              }
          }
          stage('Deploy') {
              steps {
                  sh 'scp target/*.jar user@deploy-server:/path/to/deploy'
              }
          }
      }
      post {
          success {
              echo '构建成功'
          }
          failure {
              echo '构建失败'
          }
      }
  }
  

2. 脚本化Pipeline（可选）

• 适用于复杂逻辑，需使用node块和Groovy语法：

  node('ubuntu-server') {
      stage('Build') {
          sh 'echo "Building on Ubuntu..."'
          // 调用Shell脚本
          sh './scripts/build.sh'
      }
  }
  

3. 关键规范

• 命令格式：使用sh执行Shell命令，确保脚本可跨平台兼容。
• 权限管理：通过chmod +x赋予脚本执行权限，避免直接在Pipeline中写高危命令（如rm -rf）。
• 日志输出：使用echo或println记录关键步骤，便于调试。
• 参数化设计：通过parameters定义可配置参数（如分支、环境），提升复用性。

三、高级实践

1. 共享库与模块化
   将通用逻辑（如部署脚本）封装到Jenkins共享库，通过@Library引用。

2. 安全增强

   • 使用withCredentials安全处理敏感信息（如密码、API密钥）。
   • 禁止在Pipeline中直接存储敏感数据，通过Jenkins凭证管理。

3. 并行与条件执行

   • 并行执行多阶段任务（如同时运行单元测试和集成测试）：

     parallel {
         stage('Unit Test') { steps { sh 'mvn test' } }
         stage('Integration Test') { steps { sh 'mvn verify -DskipUnitTests' } }
     }
     

   • 基于条件执行步骤（如仅主分支部署到生产环境）：

     stage('Deploy to Prod') {
         when {
             branch 'main'
         }
         steps {
             sh 'kubectl apply -f deployment.yaml'
         }
     }
     

四、验证与维护

1. 语法检查
   在Jenkins中通过“Pipeline Syntax”工具验证脚本合法性。

2. 日志与监控

   • 通过Jenkins Blue Ocean或Stage View查看执行详情。
   • 定期清理工作区（post { always { cleanWs() } }）。

3. 版本迭代
   每次修改Jenkinsfile后，通过Git提交并触发Pipeline自动构建，确保变更可追溯。

参考来源：