集中管理 JenkinsFile：一步步教程 - Pipeline script from SCM

刺骨的言语ヽ痛彻心扉 2023-10-10 17:26 21阅读 0赞

#### 集中管理 JenkinsFile：一步步教程 - Pipeline script from SCM ####

*   *  准备工作
     *  第一步：创建 JenkinsFile 集中存放仓库
     *  第二步：将各项目 JenkinsFile 放入集中仓库
     *  第三步：在 Jenkins 中创建 Pipeline 项目
     *  第四步：创建集中仓库的 Jenkinsfile
     *  第五步：观察魔法发生
     *  后记：其他实用技巧

你是否有过这样的困扰：每个项目都有一个 JenkinsFile 文件，但是这些文件散布在不同的项目仓库中，导致管理和维护成为一件繁琐的事情？别担心，今天我们将一起探讨如何实现  
JenkinsFile 的集中管理，并在每天中午12点进行集体测试发布。让我们一起走进 JenkinsFile 集中管理的奇幻世界！

要将所有 JenkinsFile 文件集中放在一个项目中，并在中午12点进行集体测试发布，可以按照以下步骤实现：

1.  在Git仓库中创建一个新的项目，例如叫做 “jenkinsfile-collection”，用于存放所有项目的 JenkinsFile 文件。
2.  在 “jenkinsfile-collection” 项目中，为每个需要测试发布的项目创建一个子目录，并将各项目的 JenkinsFile 文件放入对应子目录中。确保每个  
    JenkinsFile 文件内有正确的构建、测试和发布流程。
3.  在 Jenkins 服务器上创建一个新的 Pipeline 项目，例如命名为 “centralized-jenkinsfiles”。在项目配置页面的 Pipeline  
    部分，选择 “Pipeline script from SCM” 选项，并填写 “jenkinsfile-collection” 项目的仓库地址。
4.  在 “centralized-jenkinsfiles” 项目的 Build Triggers 部分，选择 “Build periodically” 选项。在 Schedule 栏中输入适当的  
    cron 表达式，以便在每天的中午12点触发构建。例如，对于每天的12:00 PM，可以使用以下 cron 表达式： 0 12 \* \* \*
5.  在 “jenkinsfile-collection” 项目中，创建一个名为 “Jenkinsfile” 的文件，此文件将用于驱动所有其他 JenkinsFile 文件的执行。
6.  保存 “centralized-jenkinsfiles” 项目的配置。现在，当中午12点到达时，Jenkins 将自动执行 “centralized-jenkinsfiles”  
    项目，从而触发 “jenkinsfile-collection” 项目中的所有 JenkinsFile 文件，实现集体测试发布。

### 准备工作 ###

首先，确保你的 Jenkins 服务器已经搭建好并且可以正常访问。如果你还没搭建 Jenkins  
服务器，可以参考 [官方文档][Link 1] 进行安装。

### 第一步：创建 JenkinsFile 集中存放仓库 ###

在这个步骤中，我们将创建一个 Git 仓库，用于集中存放所有项目的 JenkinsFile 文件。你可以把这个仓库当成 JenkinsFile 的乐园，各个  
JenkinsFile 在这里自由地玩耍和交流。

# 创建一个名为 "jenkinsfile-collection" 的仓库
    git init jenkinsfile-collection
    cd jenkinsfile-collection
    
    # 创建一个 README.md 文件，简要介绍项目
    echo "# Jenkinsfile Collection" > README.md
    git add README.md
    git commit -m "Initial commit"

### 第二步：将各项目 JenkinsFile 放入集中仓库 ###

在这个步骤中，我们将把各个项目的 JenkinsFile 文件放入集中仓库的对应子目录中。这就像把孩子们接到幼儿园，每个孩子有自己的小房间和小床。

假设我们有两个项目：`project-a` 和 `project-b`，分别有名为 `Jenkinsfile-a` 和 `Jenkinsfile-b` 的 JenkinsFile 文件。

# 在集中仓库中为每个项目创建子目录
    mkdir project-a project-b
    
    # 将各项目的 JenkinsFile 文件复制到对应子目录
    cp /path/to/project-a/Jenkinsfile-a project-a/Jenkinsfile
    cp /path/to/project-b/Jenkinsfile-b project-b/Jenkinsfile
    
    # 将更改提交到 Git 仓库
    git add project-a project-b
    git commit -m "Add JenkinsFile files for project-a and project-b"

注意：确保每个 JenkinsFile 文件内有正确的构建、测试和发布流程。

### 第三步：在 Jenkins 中创建 Pipeline 项目 ###

接下来，我们需要在 Jenkins 服务器上创建一个新的 Pipeline 项目，用于驱动集中仓库中的 JenkinsFile  
文件执行。这就像请了一个老师来管理这个幼儿园，负责每天的课程和活动。

1.  登录到 Jenkins 服务器，点击左侧的 “New Item”。
2.  输入项目名称，例如 “centralized-jenkinsfiles”，选择 “Pipeline” 类型，然后点击 “OK”。
3.  在项目配置页面的 Pipeline 部分，选择 “Pipeline script from SCM” 选项，并填写 “jenkinsfile-collection” 项目的仓库地址。

// 示例：配置 Jenkins 从 Git 仓库中获取 Jenkinsfile
    // 将 YOUR_GIT_REPO_URL 替换为你的 "jenkinsfile-collection" 仓库地址
    pipeline {
        
        agent any
        stages {
        
            stage('Checkout SCM') {
        
                steps {
        
                    git(url: 'YOUR_GIT_REPO_URL')
                }
            }
        }
    }

1.  在 “centralized-jenkinsfiles” 项目的 Build Triggers 部分，选择 “Build periodically” 选项。在 Schedule 栏中输入适当的  
    cron 表达式，以便在每天的中午12点触发构建。例如，对于每天的12:00 PM，可以使用以下 cron 表达式：

0 12 * * *

### 第四步：创建集中仓库的 Jenkinsfile ###

在这个步骤中，我们将在 “jenkinsfile-collection” 项目中创建一个名为 “Jenkinsfile” 的文件，此文件将用于驱动所有其他  
JenkinsFile 文件的执行。这个文件就像幼儿园的课程表，安排每个孩子参与不同的活动。

在 “jenkinsfile-collection” 项目中，创建一个名为 “Jenkinsfile” 的文件，并添加以下内容：

pipeline {
        
        agent any
    
        stages {
        
            stage('Execute JenkinsFiles') {
        
                steps {
        
                    script {
        
                        def projectDirs = findDirs()
    
                        for (int i = 0; i < projectDirs.size(); i++) {
        
                            def projectName = projectDirs[i].name
                            def jenkinsfilePath = "${projectName}/Jenkinsfile"
    
                            if (fileExists(jenkinsfilePath)) {
        
                                echo "Running JenkinsFile for project '${projectName}'"
                                load jenkinsfilePath
                            } else {
        
                                echo "No JenkinsFile found for project '${projectName}'"
                            }
                        }
                    }
                }
            }
        }
    }
    
    def findDirs() {
        
        return sh(
                script: "find . -mindepth 1 -maxdepth 1 -type d",
                returnStdout: true
        ).trim().split("\n").collect {
         new File(it) }
    }

将此 Jenkinsfile 添加到 Git 仓库，并提交更改：

git add Jenkinsfile
    git commit -m "Add main Jenkinsfile to drive execution of other JenkinsFile files"

### 第五步：观察魔法发生 ###

现在一切准备就绪，我们只需要等待中午12点的到来。当时间一到，Jenkins 将自动执行 “centralized-jenkinsfiles” 项目，触发 "  
jenkinsfile-collection" 项目中的所有 JenkinsFile 文件，实现集体测试发布。

你可以随时登录到 Jenkins 服务器，查看构建状态和日志。如果需要手动触发构建，只需点击 “centralized-jenkinsfiles” 项目旁边的 "  
立即构建" 按钮。

通过本教程，你已经学会了如何实现 JenkinsFile 的集中管理，并在每天中午12点进行集体测试发布。这就像把一个充满活力的幼儿园建立起来，每个  
JenkinsFile 都有自己的角色和任务，而我们的 “老师” Jenkins 负责管理和执行这些任务。现在，你可以轻松地对所有 JenkinsFile  
文件进行统一管理，从而提高工作效率和项目的可维护性。

### 后记：其他实用技巧 ###

在实际操作过程中，你可能会遇到一些问题或者需要实现更多功能。下面是一些实用技巧，帮助你更好地管理 JenkinsFile：

1.  **优化 Jenkinsfile 结构** ：为了提高可读性和可维护性，你可以考虑将 Jenkinsfile  
    的各个部分拆分为单独的脚本或者使用共享库。这样一来，你可以更方便地复用和更新代码。
2.  **更灵活的触发机制** ：除了每天中午12点进行集体测试发布外，你还可以根据需求调整触发机制。例如，你可以设置在每次代码提交后立即触发构建，或者根据项目的不同设置不同的触发时间。
3.  **增加安全性** ：为了保护你的代码和构建环境，你可以对 Jenkins 服务器进行安全加固，例如启用身份验证、限制访问权限、配置  
    HTTPS 等。
4.  **实现自动化部署** ：通过使用像 Kubernetes、Docker 等现代化部署工具，你可以将项目从测试环境无缝迁移到生产环境，进一步提高开发效率。

通过掌握以上技巧，你将能够更好地管理 JenkinsFile，让你的项目变得更加高效和健壮。祝你在 JenkinsFile 集中管理的世界里玩得愉快！

[Link 1]: https://www.jenkins.io/doc/book/installing/