jenkins-deployer
SKILL.md
Jenkins 发布器 Skill
概览
- 用途:触发 Jenkins 测试环境部署
- 输入:服务名(Jenkins job)+ 区服
- 方式:必须通过 Jenkins API 触发
⚠️ 重要警告
禁止发布到正式环境(线上环境)!
- 本工具仅用于测试环境部署
- 所有区服参数都包含“测试环境”后缀
- 生产环境部署必须通过其他安全流程进行
首次使用(认证配置)
脚本需要 Jenkins 用户名和 API Token 才能触发部署。首次使用需要配置认证信息,后续使用无需重复配置。认证信息从 ~/.jenkins/auth 文件读取。
创建 ~/.jenkins/auth 文件,格式如下:
# Jenkins 认证配置
user=your_username
token=your_api_token
示例:
mkdir -p ~/.jenkins
cp ~/.codex/skills/jenkins-deployer/auth.example ~/.jenkins/auth
# 然后编辑 ~/.jenkins/auth 文件,填写你的认证信息
chmod 600 ~/.jenkins/auth
注意事项:
- 文件格式:
key=value,每行一个配置项 - 支持注释:以
#开头的行会被忽略 - 支持的 key:
user或username(用户名)、token(API Token) - 建议设置文件权限为
600,只允许所有者读写
日常使用
参数说明:
- 服务名:必须是完整 job 名称(本地参考列表见
-h/--help) - 区服:测试环境区服;支持多区服逗号分隔
校验与使用流程:
- 先用
-s/--search通过关键词/短语匹配服务名(可能返回多个候选) - 若返回多个候选,用户根据列表选择一个更明确的服务名
- 若未匹配,再用
-h/--help查看本地参考列表 - 选择匹配的完整服务名后再发布
命令示例:
# 通过关键词搜索服务名
python3 ~/.codex/skills/jenkins-deployer/scripts/jenkins_deploy.py -s "谁是卧底"
# 部署服务到单个区服
python3 ~/.codex/skills/jenkins-deployer/scripts/jenkins_deploy.py --service weplayDev-api_server --region "TUR-土语服-测试环境"
# 部署到多个区服(逗号分隔)
python3 ~/.codex/skills/jenkins-deployer/scripts/jenkins_deploy.py --service weplayDev-api_server --region "TUR-土语服-测试环境,FRA-阿语服-测试环境"
# 部署到所有大区
python3 ~/.codex/skills/jenkins-deployer/scripts/jenkins_deploy.py --service weplayDev-tmproom --region "ALL-所有大区"
# 查看帮助(-h 会展示本地可用列表,供快速参考)
python3 ~/.codex/skills/jenkins-deployer/scripts/jenkins_deploy.py --help
支持的区服列表(本地参考)
ALL-所有大区SGP-华语服-测试环境BKK-泰服-测试环境MAS-马尼服-测试环境PHL-菲律宾服-测试环境VNM-越南服-测试环境TKY-日服-测试环境SEL-韩服-测试环境FRA-阿语服-测试环境TUR-土语服-测试环境IN-印度服-测试环境PK-巴基斯坦服-测试环境RUS-俄语服-测试环境SV-美服-测试环境BR-葡语服-测试环境VA-西语服-测试环境PAR-法语服-测试环境DE-德语服-测试环境IT-意语服-测试环境Jackaroo-AR-阿语服-测试环境