Jenkins构建后执行脚本的全面指南

小蓝 • 2024-12-12 12:11 • 编程

一、执行脚本的基础

在了解如何在Jenkins构建后执行脚本之前，需要先了解如何执行脚本。在Unix或Linux命令行中，可以通过在终端中输入脚本路径并按下“Enter”来运行脚本。但是，在Jenkins中，我们需要使用插件和特定的配置来执行脚本。

一种简单的方法是在Jenkins的构建配置页面中添加一个“Execute shell”步骤。这个步骤允许我们在构建完成后执行任意的Shell命令或脚本。

#! /bin/bash
echo "Hello World"

每次构建该项目时，Jenkins会自动运行上面的脚本，每次输出“Hello World”。

二、使用Jenkins构建后执行脚本插件

如果需要执行的脚本需要在每个构建之后都运行，那么手动添加“Execute shell”步骤就不太可行了。这时候，我们可以使用Jenkins “Post-build Script” 插件。

在Jenkins插件管理中搜索“Post-build Script”插件并安装它。然后，打开构建配置页面，选择“Add post-build action”并选择“Post-build Script”。

在插件的“Script”文本框中输入需要执行的脚本。例如：

#! /bin/bash
echo "This is a script that runs after the build"

当构建结束时，该脚本将会自动运行。

三、使用Jenkins Pipeline执行脚本

Jenkins Pipeline是一种强大的工具，可用于在Jenkins中定义和管理复杂的构建流程，并允许在Jenkins运行期间编写和执行脚本。在Jenkins Pipeline中，可以轻松地执行构建后的脚本。

首先，创建一个Jenkinsfile并添加以下内容：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                // steps to build the project
            }
        }
    }
    post {
        always {
            sh '''
              echo "This is a script that runs after the build"
            '''
        }
    }
}

在以上示例中，“post”段定义了需要在构建结束之后运行的脚本。“always”段表示无论构建是否成功，都会运行这个脚本。然后，执行一个Shell脚本，输出文本“这是一个在构建之后运行的脚本”。

四、使用脚本来执行脚本

如果需要前一个构建的输出作为后一个构建的输入，那么可以使用Jenkins的“Copy Artifact”插件。使用它可以下载之前构建的输出中的某些文件。

然后，将它们拷贝到当前构建的工作区，并执行一些有用的操作，如测试或分析。下面演示一个脚本，它会使用“Copy Artifact”插件下载之前构建的WAR文件，然后将构建后的WAR文件复制到Tomcat的webapps目录中，最后重启Tomcat。

#!/bin/bash
# Download previous build's WAR file
JAR_NAME="$(ssh jenkins@build curl http://jenkins/builds/job/My_Job/$BUILD_NUMBER/artifact/*.war)"
wget --no-verbose "${JAR_NAME}" -O app.war

# Stop Tomcat
sudo /etc/init.d/tomcat7 stop

# Deploy the new WAR file
sudo cp app.war /var/lib/tomcat7/webapps/

# Restart Tomcat
sudo /etc/init.d/tomcat7 start

五、用shell脚本和Jenkins API来执行脚本

Jenkins提供了一组API，可以轻松地在脚本中与Jenkins进行交互。例如，“build job”API可以用来启动其他Jenkins作业。这在需要构建依赖于其他作业输出的复杂项目中非常有用。

例如，下面是一个脚本，它在构建完成后将WAR文件上传到Amazon S3，然后启动发布工作流程。使用Jenkins API，它会下载上一个构建的WAR文件并将其同步到Amazon S3中。

#!/bin/bash
# Download previous build's WAR file
JAR_NAME="$(ssh jenkins@build curl http://jenkins/builds/job/My_Job/$BUILD_NUMBER/artifact/*.war)"
wget --no-verbose "${JAR_NAME}" -O app.war

# Copy WAR file to Amazon S3 bucket
aws s3 cp app.war s3://my-s3-bucket/

# Start a "publish" job
JOB_NAME='publish_job'
BUILD_RESULT="$(curl -X POST -q "http://jenkins/job/${JOB_NAME}/buildWithParameters?Version=${VERSION}")"
echo "Build result: ${BUILD_RESULT}"

六、小结

以上是使用Jenkins进行构建后执行脚本的几种方法。在实践中，可以根据特定项目的需要使用适当的方法。不管使用哪种方法，确保脚本可以成功获取必要的输入，执行所需的操作并正确地处理错误是非常重要的。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/238564.html