Jenkins Pipeline 完整示例

pipeline {
    // 1. Agent 配置：指定在哪个节点运行
    // 'any' 表示任意可用的 agent
    // 也可以指定标签，如 label 'docker-node'
    agent any

    // 2. 环境变量定义
    // 这里定义的变量可以在整个 Pipeline 中使用
    environment {
        // 从 Jenkins 凭证管理中获取 Docker 仓库密码
        // 'docker-hub' 是你在 Jenkins 中创建的凭证 ID
        DOCKER_CREDENTIALS = credentials('docker-hub')
        // 定义应用名称
        APP_NAME = 'my-awesome-app'
        // 获取构建编号，用于打 Docker 镜像标签
        IMAGE_TAG = '{BUILD_NUMBER}'
    }

    // 3. 参数化构建
    // 允许在点击“立即构建”时手动输入参数
    parameters {
        string(name: 'VERSION', defaultValue: '1.0', description: '请输入构建的版本号')
        booleanParam(name: 'DEBUG_BUILD', defaultValue: false, description: '是否开启调试模式？')
    }

    // 4. 主要执行阶段
    stages {
        // 阶段 1：检出代码
        stage('检出代码') {
            steps {
                script {
                    echo '开始拉取代码...'
                    // 删除工作空间旧文件（相当于 clean）
                    cleanWs()
                }
                // 使用 Git 插件拉取代码
                // 替换为你自己的仓库地址
                git branch: 'main',
                     url: 'https://github.com/yourname/your-repo.git',
                     credentialsId: 'github-token' // 如果是私有仓库需要凭证
            }
        }

        // 阶段 2：依赖安装与构建
        stage('构建项目') {
            steps {
                script {
                    echo '开始构建项目，版本: {params.VERSION}'

                    // 示例：如果是 Node.js 项目
                    // sh 'npm install'
                    // sh 'npm run build'

                    // 示例：如果是 Maven 项目
                    // sh 'mvn clean package -DskipTests'

                    // 这里我们模拟一个构建过程
                    sh 'echo "模拟编译过程..."'
                    sh 'sleep 5' // 模拟耗时操作
                }
            }
        }

        // 阶段 3：运行测试
        stage('运行测试') {
            steps {
                script {
                    echo '运行单元测试...'
                    // 这里可以集成 JUnit 测试报告
                    // sh 'mvn test'
                    sh 'echo "测试通过！"'

                // 归档测试报告（如果有的话）
                // junit '**/target/surefire-reports/*.xml'
                }
            }
        }

        // 阶段 4：代码质量检查 (SonarQube 示例)
        stage('代码质量检查') {
            steps {
                script {
                    echo '正在扫描代码质量...'
                // 需要安装 SonarQube Scanner 插件
                // withSonarQubeEnv('MySonarServer') {
                //     sh 'mvn sonar:sonar'
                // }
                }
            }
        }

        // 阶段 5：制作 Docker 镜像
        stage('打包 Docker 镜像') {
            when {
                // 仅在 master 分支执行
                branch 'main'
            }
            steps {
                script {
                    echo '正在构建 Docker 镜像...'
                    // 使用 Docker 插件
                    docker.build('{env.APP_NAME}:{env.IMAGE_TAG}')
                }
            }
        }

        // 阶段 6：部署
        stage('部署到服务器') {
            when {
                expression {
                    // 只有构建参数 DEBUG_BUILD 为 false 时才部署
                    return !params.DEBUG_BUILD
                }
            }
            steps {
                script {
                    echo '开始部署应用...'
                    // 这里可以使用 SSH 插件发送脚本到远程服务器
                    // sshPublisher(publishers: [
                    //     sshPublisherDesc(
                    //         configName: 'prod-server',
                    //         transfers: [sshTransfer(cleanRemote: false, excludes: '', execCommand: 'docker-compose up -d', ...)]
                    //     )
                    // ])

                    // 模拟部署
                    sh 'echo "应用已部署到生产环境！"'
                }
            }
        }
    }

    // 5. 无论构建成功还是失败，都会执行的清理或通知步骤
    post {
        // 构建成功
        success {
            steps {
                echo '🎉 构建成功！'
            // 发送企业微信或钉钉通知
            // slackSend channel: '#jenkins', message: "构建成功: {env.BUILD_URL}"
            }
        }

        // 构建失败
        failure {
            steps {
                echo '🚨 构建失败！请检查日志。'
                // 发送邮件通知负责人
                emailext(
                    subject: '构建失败: {currentBuild.fullDisplayName}',
                    body: "请登录 Jenkins 查看详细日志: ${env.BUILD_URL}",
                    to: 'dev-team@example.com'
                )
            }
        }

        // 始终执行（归档制品）
        always {
            steps {
                script {
                    // 归档构建产物（如 jar 包、zip 文件）
                    // 这样可以在 Jenkins 界面下载
                    archiveArtifacts artifacts: 'target/*.jar', fingerprint: true
                }
            }
        }

        // 清理工作空间
        cleanup {
            cleanWs()
        }
    }
}