当前位置：首页 > article >正文

Jenkinsfile怎么写

article 2025/2/24 15:12:57

1. 理解 Jenkins 和 Jenkinsfile

2. 基本概念

3. Jenkinsfile 结构

示例：Declarative Pipeline

各部分拆解讲解

Pipeline 声明

Agent 声明

Environment 环境变量

Options

Stages

Steps

Post 部分

4. 学习资料

5. 实践运用

学习和运用 Jenkinsfile 是熟练使用 Jenkins 进行持续集成和持续交付（CI/CD）流程的关键一步。这段时间也是学有所成和大家分享下学习成果：

1. 理解 Jenkins 和 Jenkinsfile

Jenkins 是一个开源的自动化服务器，可以用于构建、测试、部署软件项目。
Jenkinsfile 是用来定义 Jenkins Pipeline 的文本文件，使用领域特定语言（DSL）编写。它允许你将构建过程作为代码来管理，便于版本控制和协作。

2. 基本概念

Pipeline：表示工作流的完整过程，由一系列阶段（Stage）构成。
Stage：Pipeline 中的逻辑划分，每个阶段可以包含一个或多个步骤。
Step：执行具体动作的基本构建单元，例如运行命令、构建项目。

3. Jenkinsfile 结构

Jenkinsfile 可以用两种不同的语法编写：Declarative 和 Scripted。Declarative 是较新的语法，更加简单和结构化。

示例：Declarative Pipeline

pipeline {
    agent any 

    stages {
        stage('Build') { 
            steps {
                echo 'Building..'
                // Add build steps here
            }
        }
        stage('Test') { 
            steps {
                echo 'Testing..'
                // Add test steps here
            }
        }
        stage('Deploy') { 
            steps {
                echo 'Deploying....'
                // Add deploy steps here
            }
        }
    }
}

各部分拆解讲解

Pipeline 声明
```
pipeline {
    ...
}
```
- 声明这是一个 Pipeline 脚本，所有内容需包含在大括号内。
Agent 声明
```
agent any
```
- 指定在任何可用的 Jenkins 节点上执行 Pipeline。具体的节点可以通过指定标签来限定。
Environment 环境变量
```
environment {
    NODE_ENV = 'production'
}
```
- 定义一个环境变量 NODE_ENV，在 Pipeline 的所有步骤中都可以使用。
Options
```
options {
    timeout(time: 1, unit: 'HOURS')
}
```
- 定义一些全局性的选项，如设置 Pipeline 的超时时间为 1 小时，防止长时间运行；或者加入一些定时的操作（利用cron）
Stages
```
stages {
    stage('Stage Name') {
        steps {
            // ...
        }
    }
    ...
}
```
- 定义 Pipeline 的各个阶段（Stage）。每个阶段包含步骤（Steps），具体执行的操作写在步骤中。
Steps
- Checkout 代码
```
stage('Checkout') { 
    steps {
        checkout scm
    }
}
```
  - 使用 checkout scm 从版本控制系统中检出代码，通常会从 Git 仓库拉取源代码。
- Build 构建
```
stage('Build') {
    steps {
        sh 'npm install'
    }
}
```
  - 在这个阶段，通过 sh 执行 Shell 命令来安装项目依赖。
- Test 测试
```
stage('Test') {
    steps {
        sh 'npm test'
    }
}
```
  - 运行测试命令，确保代码无误。
- Deploy 部署
```
stage('Deploy') {
    steps {
        input message: 'Approve deployment?', ok: 'Deploy'
        sh 'npm run deploy'
    }
}
```
  - 在部署阶段之前，使用 input 来进行手动审批，然后运行部署脚本。
Post 部分
```
post {
    success {
        echo 'Pipeline succeeded!'
    }
    failure {
        echo 'Pipeline failed.'
    }
    always {
        cleanWs()
    }
}
```
- success: 当 Pipeline 成功时执行。
- failure: 当 Pipeline 失败时执行。
- always: 不论成功与否，都执行，比如清理工作空间或者发送邮件到个人邮箱。