1. stage
stage函数用于定义Jenkins Pipeline中的阶段。一个流水线可以由多个阶段组成,每个阶段代表一个独立的任务或操作。阶段提供了工作的逻辑分割,并且可以更好地可视化和监控流水线的进度。
pipeline {
agent any
stages {
stage('构建') {
steps {
// 构建任务
}
}
stage('测试') {
steps {
// 测试任务
}
}
stage('部署') {
steps {
// 部署任务
}
}
}
}
stage函数允许您将流水线组织成有意义且易于管理的块,使得理解和排查问题更加容易。
2. node
node函数用于分配Jenkins中的代理节点(agent node),以执行流水线中的任务。代理节点可以是Jenkins主节点或其他已注册的节点,这些节点具有所需的工具和配置。
pipeline {
agent {
node {
label 'my-node'
}
}
stages {
stage('构建') {
steps {
// 构建任务
}
}
}
}
通过指定node函数,您可以确保特定的任务在所需的代理节点上执行,基于标签或其他条件。
3. git
git函数用于配置和使用Git源代码管理。它可以克隆代码库、检出指定的分支或标签,并执行其他与Git相关的操作。
pipeline {
agent any
stages {
stage('检出') {
steps {
git branch: 'master', url: 'https://github.com/myrepo.git'
}
}
stage('构建') {
steps {
// 构建任务
}
}
}
}
git函数使您能够在流水线中进行常见的Git操作,从而实现对代码版本的管理和控制。
4. sh
sh函数用于在流水线中执行Shell命令。它可以用于运行构建脚本、执行测试命令或执行其他与Shell相关的任务。
pipeline {
agent any
stages {
stage('构建') {
steps {
sh 'make'
}
}
stage('测试') {
steps {
sh 'pytest'
}
}
}
}
sh函数允许您在流水线中执行任意的Shell命令,以满足特定的构建和测试需求。
5. input
input函数用于在流水线中请求用户输入。它可以用于暂停流水线的执行,直到用户提供所需的输入。
pipeline {
agent any
stages {
stage('部署') {
steps {
input message: '是否部署到生产环境?', ok: '部署'
}
}
}
}
input函数允许您与用户交互,例如在关键阶段需要用户确认或提供参数时。
6. timeout
timeout函数用于设置流水线中某个阶段或步骤的超时时间。如果超过指定的时间限制,流水线将失败或终止。
pipeline {
agent any
stages {
stage('部署') {
steps {
timeout(time: 1, unit: 'HOURS') {
sh 'deploy.sh'
}
}
}
}
}
timeout函数可用于设置流水线中长时间运行任务的超时保护,防止流水线在异常情况下无限期地阻塞。
7. echo
echo函数用于在流水线中输出消息。它可以用于显示构建和测试过程中的状态、结果或其他自定义信息。
pipeline {
agent any
stages {
stage('构建') {
steps {
echo '开始构建...'
// 构建任务
echo '构建完成!'
}
}
}
}
echo函数允许您向控制台输出文本消息,以便进行调试、状态报告或其他目的。
8. error
error函数用于在流水线中抛出一个错误,并使流水线失败。它可以用于检测错误条件并终止流水线的执行。
pipeline {
agent any
stages {
stage('测试') {
steps {
sh 'pytest'
error '测试未通过'
}
}
}
}
error函数可用于在流水线中显式地引发错误,以便及时停止流水线并通知相关人员。
9. archiveArtifacts
archiveArtifacts函数用于归档构建产物。它可以将构建生成的文件或目录保存起来,以便后续的部署或存档目的。
pipeline {
agent any
stages {
stage('构建') {
steps {
// 构建任务
archiveArtifacts artifacts: 'target/*.jar', fingerprint: true
}
}
}
}
archiveArtifacts函数允许您指定要归档的文件或目录,并将其保存在Jenkins中以供以后使用。
10. mail
mail函数用于在流水线中发送电子邮件通知。它可以用于在流水线的特定阶段或步骤完成后通知相关人员。
pipeline {
agent any
stages {
stage('部署') {
steps {
sh 'deploy.sh'
mail to: 'team@example.com', subject: '部署完成', body: '部署已完成成功!'
}
}
}
}
mail函数允许您发送电子邮件通知,以便及时地将流水线的状态或结果通知给相关人员。
这些是Jenkins Pipeline中最常用的十个函数。通过熟练掌握这些函数,您可以更加灵活和高效地构建和管理持续交付流程。