Jenkins如何实现自定义脚本

Jenkins实现自定义脚本的常见方法

1. 使用Freestyle Project添加Shell/批处理构建步骤

Freestyle Project是Jenkins的传统项目类型，适合简单场景的自定义脚本执行。

• 创建项目：登录Jenkins，点击“新建Item”，输入名称并选择“Freestyle project”。
• 配置基础信息：设置源码管理（如Git）、构建触发器（如定时构建、SCM轮询）等。
• 添加构建步骤：在“构建”选项卡中，点击“增加构建步骤”，选择“Execute shell”（Linux/macOS）或“Execute Windows batch command”（Windows）。
• 编写脚本：在命令框中输入自定义脚本，例如：
  • Linux/macOS（安装依赖并构建）：

    #!/bin/bash
    npm install
    npm run build
    

  • Windows（编译Java项目）：

    mvn clean package
    java -jar target/yourApp.jar
    

• 保存并运行：点击“保存”，手动触发或等待触发条件满足时执行构建。

2. 使用Pipeline（声明式/脚本式）定义流水线脚本

Pipeline是Jenkins推荐的自动化流程工具，通过Groovy DSL定义构建流程，支持版本控制、复用和复杂逻辑。

• 创建Pipeline Job：点击“新建Item”，输入名称并选择“Pipeline”。
• 配置脚本来源：
  • Pipeline script：直接在Jenkins界面编写Groovy脚本（适合简单场景）。
  • Pipeline script from SCM：从Git等版本控制系统拉取脚本（推荐，便于版本管理）。
• 编写Pipeline脚本：使用声明式或脚本式语法定义阶段（stages），例如：

  pipeline {
      agent any  // 指定执行节点
      stages {
          stage('Build') {
              steps {
                  sh 'npm install'  // 执行Shell命令
                  sh 'npm run build'
              }
          }
          stage('Test') {
              steps {
                  sh 'npm test'  // 运行测试
              }
          }
          stage('Deploy') {
              steps {
                  script {
                      // 动态生成部署脚本
                      sh '''
                          cat > deploy.sh <<EOF
                          echo "Deploying to production..."
                          scp -r ./dist/* user@server:/var/www/html
                          EOF
                      '''
                      sh 'chmod +x deploy.sh && ./deploy.sh'  // 执行部署脚本
                  }
              }
          }
      }
  }
  

• 保存并运行：点击“保存”，手动触发或通过SCM触发构建。

3. 使用SSH插件执行远程脚本

若需在远程服务器上执行自定义脚本（如部署到生产环境），可通过SSH插件实现。

• 安装插件：进入“Manage Jenkins” → “Manage Plugins”，搜索“SSH Plugin”并安装。
• 配置SSH主机：进入“Manage Jenkins” → “Configure System”，找到“SSH Sites”，添加远程主机信息（主机名、端口、用户名、密码/SSH密钥）。
• 配置Job：在Job的“构建环境”中勾选“Execute shell script on remote host using ssh”，选择已配置的SSH站点，输入要执行的远程脚本命令（如sh /path/to/remote_script.sh）。
• 保存并运行：点击“保存”，构建时会自动连接远程主机并执行脚本。

4. 使用Groovy脚本控制复杂逻辑

对于需要动态调整构建流程的场景（如根据条件跳过阶段、调用外部API），可通过Groovy脚本实现。

• 系统管理脚本：进入“Manage Jenkins” → “Script Console”，直接编写Groovy脚本（如修改Job配置、查询构建状态）。
• Pipeline中的脚本块：在Pipeline脚本中使用script块嵌入Groovy代码，例如：

  pipeline {
      agent any
      stages {
          stage('Dynamic Step') {
              steps {
                  script {
                      def shouldDeploy = env.BRANCH_NAME == 'main'  // 条件判断
                      if (shouldDeploy) {
                          sh 'echo "Deploying main branch..."'
                      } else {
                          echo 'Skipping deployment for non-main branches.'
                      }
                  }
              }
          }
      }
  }
  

• 注意事项：Groovy脚本需符合Jenkins的语法规则，复杂逻辑建议封装为共享库（Shared Library）以提高复用性。