Python自动化部署项目教程_JenkinsGitHubActions实战

Jenkins适合需灵活控制流程的Python项目,通过Jenkinsfile实现多环境自动化部署;GitHub Actions更轻量,适合GitHub托管的小型项目;部署前须检查依赖锁定、配置分离、启动脚本和.gitignore遗漏。

用 Jenkins 实现 Python 项目的自动化部署

Jenkins 是最成熟的 CI/CD 工具之一,适合需要灵活控制构建流程、多环境部署(如测试服/预发服/生产服)的 Python 项目。核心是把“代码提交 → 测试 → 打包 → 部署”这一串操作写成可重复执行的流水线。

关键准备动作:

  • 确保 Jenkins 服务器能访问你的 GitHub 仓库(配置 SSH Key 或 Personal Access Token)
  • 在项目根目录添加 Jenkinsfile(声明式流水线),例如:
pipeline {
    agent any
    environment {
        PYTHONPATH = "${WORKSPACE}"
    }
    stages {
        stage('Checkout') {
            steps { checkout scm }
        }
        stage('Install Dependencies') {
            steps { sh 'pip install -r requirements.txt' }
        }
        stage('Run Tests') {
            steps { sh 'pytest tests/ --tb=short' }
        }
        stage('Deploy to Staging') {
            when { branch 'develop' }
            steps { sh 'rsync -avz --delete ./ user@staging-server:/opt/myapp/' }
        }
        stage('Deploy to Production') {
            when { branch 'main' }
            steps { 
                input message: 'Deploy to production?', ok: 'Yes, proceed'
                sh 'rsync -avz --delete ./ user@prod-server:/opt/myapp/'
            }
        }
    }
}

注意:生产部署加了人工确认步骤,避免误触发;Python 服务建议配合 systemd 或 supervisor 管理进程启停。

用 GitHub Actions 替代 Jenkins 的轻量方案

如果你的项目托管在 GitHub、团队规模不大、不想维护 Jenkins 服务器,GitHub Actions 更简单直接——所有配置写在 .github/workflows/deploy.yml 里,无需额外运维。

一个典型的 Python Web 应用(如 Flask)自动部署示例:

  • 监听 main 分支 push 事件
  • 在 Ubuntu runner 上安装 Python、依赖、运行测试
  • 通过 SSH 登录远程服务器,拉取最新代码并重启服务
name: Deploy to Server
on:
  push:
    branches: [main]

jobs: deploy: runs-on: ubuntu-latest steps:

  • uses: actions/checkout@v4

  • name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.11'

  • name: Install dependencies run: pip install -r requirements.txt

  • name: Run tests run: pytest tests/

  • name: Deploy via SSH uses: appleboy/scp-action@v0.1.7 with: host: ${{ secrets.HOST }} username: ${{ secrets.USERNAME }} key: ${{ secrets.PRIVATE_KEY }} source: "." target: "/home/ubuntu/myapp/"

  • name: Restart service uses: appleboy/ssh-action@v0.1.8 with: host: ${{ secrets.HOST }} username: ${{ secrets.USERNAME }} key: ${{ secrets.PRIVATE_KEY }} script: | cd /home/ubuntu/myapp git pull origin main sudo systemctl restart myapp.service

敏感信息(如服务器密码或私钥)必须存为 GitHub 仓库的 Secrets,不可硬编码。

Python 项目部署前必须检查的 4 件事

不管用 Jenkins 还是 GitHub Actions,自动化部署失败往往源于本地疏忽。上线前快速核对:

  • requirements.txt 是否完整锁定版本?推荐用 pip freeze > requirements.txtpip-compile 生成,避免不同环境依赖不一致
  • 配置文件是否分离?数据库地址、密钥等不能写死在代码里,应通过环境变量(os.getenv())或配置文件(如 .env + python-dotenv)注入
  • 启动脚本是否可执行?比如用 Gunicorn 启动 Flask:gunicorn --bind 0.0.0.0:8000 app:app,确保它在目标服务器上可用且端口未被占用
  • 有无忽略 .gitignore 但必需的文件?比如 alembic.ini(数据库迁移)、config.py 模板、静态资源目录等

常见问题与绕过技巧

实际跑通自动化部署常卡在这几个点:

  • SSH 权限拒绝:确保 Jenkins/GitHub Runner 使用的 SSH key 已添加到目标服务器的 ~/.ssh/authorized_keys,且服务端 sshd_config 允许公钥登录
  • 虚拟环境冲突:Jenkins 默认不用 venv,建议显式创建:python -m venv venv && source venv/bin/activate;GitHub Actions 可用 actions/setup-python 自动处理
  • 数据库迁移没执行:在部署步骤中加入 alembic upgrade headflask db upgrade,并确保迁移脚本已提交
  • 前端静态文件没更新:如果是 Flask/Django 套前端,记得加 npm install && npm run build 步骤,并把 dist/staticfiles/ 同步过去