Jenkins实战总结从零到高手的那些坑与经验分享

我的写法，亲测靠谱

在使用 Jenkins 的过程中，我积累了一些实战经验，希望能帮到大家。首先，我要分享一下我在配置 Jenkins 管道时的一些最佳实践。

Jenkinsfile 的编写

我一般这样处理 Jenkinsfile 的编写，亲测非常靠谱：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    echo 'Building...'
                    sh 'npm install'
                    sh 'npm run build'
                }
            }
        }
        stage('Test') {
            steps {
                script {
                    echo 'Testing...'
                    sh 'npm test'
                }
            }
        }
        stage('Deploy') {
            steps {
                script {
                    echo 'Deploying...'
                    sh 'scp -r dist/* user@jztheme.com:/var/www/html'
                }
            }
        }
    }
}

为什么这样写？主要是因为这种结构清晰，每个阶段的任务一目了然。而且，用 script 块包裹起来的脚本可以灵活地执行各种命令，比如 sh 命令可以执行任何 shell 脚本。

环境变量管理

环境变量管理也是一个重要的部分，我一般这样处理：

pipeline {
    environment {
        NPM_TOKEN = credentials('npm-token')
        API_URL = 'https://jztheme.com/api'
    }
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    echo "Using NPM token: ${NPM_TOKEN}"
                    withEnv(["NPM_TOKEN=${NPM_TOKEN}"]) {
                        sh 'npm install'
                        sh 'npm run build'
                    }
                }
            }
        }
        // 其他阶段...
    }
}

这样写的好处是，所有需要的环境变量都在一个地方管理，方便维护和修改。而且，通过 withEnv 块可以临时设置环境变量，避免全局污染。

这几种错误写法，别再踩坑了

在实际项目中，我也遇到过不少坑，这里给大家列举一些常见的错误写法，希望你们能避开这些坑。

错误1：直接在 Jenkinsfile 中硬编码敏感信息

我之前就干过这样的傻事：

pipeline {
    agent any
    stages {
        stage('Deploy') {
            steps {
                script {
                    sh 'scp -r dist/* user@jztheme.com:/var/www/html -i /path/to/ssh/key'
                }
            }
        }
    }
}

这种写法的问题是，敏感信息（如 SSH 密钥路径）直接暴露在代码中，不仅不安全，还容易被泄露。正确的做法是使用 Jenkins 的凭据管理插件来管理这些敏感信息。

错误2：忽略错误处理

另一个常见的错误是忽略错误处理：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    sh 'npm install'
                    sh 'npm run build'
                }
            }
        }
    }
}

这种写法没有考虑到命令执行失败的情况，一旦某个步骤失败，整个管道就会崩溃。建议加上错误处理机制，比如使用 try-catch 语句：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    try {
                        sh 'npm install'
                        sh 'npm run build'
                    } catch (err) {
                        echo "Build failed: ${err}"
                        error "Build failed, check logs for details"
                    }
                }
            }
        }
    }
}

实际项目中的坑

在实际项目中，除了上面提到的一些常见错误，还有一些坑需要注意。

构建缓存问题

在使用 npm install 时，有时会遇到缓存问题，导致构建失败。我一般这样处理：

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                script {
                    sh 'rm -rf node_modules'
                    sh 'npm install --no-cache'
                    sh 'npm run build'
                }
            }
        }
    }
}

通过删除 node_modules 目录并禁用缓存，可以避免因缓存导致的构建失败。

依赖项版本冲突

另一个常见的问题是依赖项版本冲突。我一般会在 package.json 中明确指定依赖项的版本，避免自动升级导致的兼容性问题：

{
  "name": "my-project",
  "version": "1.0.0",
  "dependencies": {
    "react": "16.14.0",
    "react-dom": "16.14.0"
  }
}

这样可以确保每次构建都使用相同的依赖项版本，避免意外的版本变更带来的问题。

总结

以上是我总结的一些 Jenkins 使用的最佳实践和踩坑经验。希望对你们有所帮助。如果有更好的方案或者补充，欢迎在评论区交流。