如何基于GitHub中的Python代码创建并运行Jenkins构建任务

我经常帮团队配置这类Jenkins任务，其实步骤很清晰，跟着做就能搞定：

一、前置准备 #

首先得确保你的Jenkins服务器上已经装了这些基础工具：

• Git：用来拉取GitHub仓库代码，直接用系统包管理工具安装即可，比如Ubuntu用sudo apt install git，CentOS用sudo yum install git。
• Python：根据你代码的版本需求安装对应版本（比如Python3.8+），可以用系统包管理工具或者官网安装包。
• Jenkins必备插件：
  1. 登录Jenkins，进入「Manage Jenkins」→「Plugins」→「Available plugins」。
  2. 搜索并安装「Git Plugin」和「Python Plugin」（如果需要指定Python版本的话），安装完成后重启Jenkins生效。

二、创建新的构建任务 #

1. 回到Jenkins首页，点击「New Item」。
2. 输入任务名称，选择「Freestyle project」，然后点击「OK」进入配置页面。

三、配置源码管理 #

1. 在任务配置页找到「Source Code Management」板块，勾选「Git」。
2. 在「Repository URL」中填入你的GitHub仓库地址（比如https://github.com/your-username/your-repo.git或者SSH地址git@github.com:your-username/your-repo.git）。
3. 配置仓库访问权限：
   • 用HTTPS地址：点击「Add」→「Jenkins」，选择「Username with password」，填入你的GitHub用户名和个人访问令牌（PAT，在GitHub设置里生成，需开启仓库读写权限），然后在「Credentials」下拉框选中刚添加的凭证。
   • 用SSH地址：生成SSH密钥对，把公钥添加到GitHub仓库的「Deploy keys」中，私钥添加到Jenkins凭证（选择「SSH Username with private key」），再选中对应的凭证即可。

四、配置构建环境（可选但推荐） #

如果你的代码需要特定版本的Python，或者要设置环境变量：

1. 找到「Build Environment」板块，勾选「Provide Python environment」。
2. 在「Python Installation」下拉框选择你之前在Jenkins全局工具配置里添加的Python版本（如果没添加过，先去「Manage Jenkins」→「Global Tool Configuration」→「Python」里新增配置）。

五、添加构建步骤 #

1. 找到「Build Steps」板块，点击「Add build step」，根据系统选择「Execute shell」（Linux/macOS）或者「Execute Windows batch command」（Windows）。
2. 在命令框中输入运行代码的指令，比如：
   • 先安装依赖（如果有requirements.txt的话）：pip install -r requirements.txt
   • 再运行主脚本：python your_main_script.py

   注意：如果系统里Python3的别名是python3，记得替换成python3 your_main_script.py。

六、保存并测试运行 #

1. 点击页面底部的「Save」按钮保存配置。
2. 回到任务页面，点击「Build Now」，Jenkins就会自动拉取GitHub代码并执行构建流程。
3. 点击构建记录里的「Console Output」，可以查看实时运行日志，排查可能出现的报错。

常见问题提醒 #

• 权限报错：检查Jenkins系统用户（比如jenkins用户）有没有拉取GitHub仓库的权限，以及执行Python、写入工作空间的权限。
• 文件找不到：确保脚本路径是相对Jenkins工作空间的，比如脚本在仓库子目录里，要写subfolder/script.py。
• 依赖安装失败：可以换用国内PyPI镜像源加速，比如pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

内容的提问来源于stack exchange，提问作者Joe