shiyun / php-jenkins
Jenkins PHP api
1.0.1
2022-07-13 08:27 UTC
Requires
- php: >=7.2
- guzzlehttp/guzzle: ^6.5.8
Requires (Dev)
- mockery/mockery: ^1.1
- phpunit/phpunit: ^7.2
README
简要
php-jenkins 是PHP语言编写的 Jenkins REST API 的工具库,旨在提供一种更方便的方式来控制 Jenkins 服务器。它提供了许多便利的功能、更高级 API。
编码标准
This projects follows PSR-0, PSR-1, PSR-2, PSR-4
快速安装
composer require shiyun/php-jenkins
快速使用
use shiyunJK/Jenkins; $config = [ 'username' => 'jenkins User ID', 'password' => 'Jenkins API token' ]; $jenkins = new Jenkins('http://localhost:8080', $config);
api参考
php-jenkins 主要实现了以下功能:
基础 base
功能 | 英文 | 手册 |
---|---|---|
获取版本信息 | Get Jenkins master version information | 参考 |
获取插件信息 | Get Jenkins plugin information | 参考 |
安装插件 | Install plugins | 参考 |
取消关机 | Cancel server shutdown mode (cancel quiet down) |
视图 views
功能 | 英文 | 手册 |
---|---|---|
创建试图 | Create views | 参考 |
删除试图 | Delete views | 参考 |
重配试图 | Reconfig views | 参考 |
获取工作空间 | wipeoutJobWorkspace | 参考 |
任务 job
功能 | 方法 | 手册 |
---|---|---|
判断任务是否存在 | jobExists | 参考 |
获取任务信息 | getJobInfo | 参考 |
重命名 | renameJob | 参考 |
创建任务 | createJob | 参考 |
复制已有任务 | copyJob | 参考 |
删除任务 | deleteJob | 参考 |
启用任务 | enableJob | 参考 |
禁用任务 | disableJob | 参考 |
获取配置 | getJobConfig | 参考 |
修改配置 | reconfigJob | 参考 |
构建 build
功能 | 英文 | 手册 |
---|---|---|
开始任务构建 | Start a build on a job | 参考 |
删除构建 | Delete Builds | 参考 |
构建列表 | List running builds | 参考 |
创建节点 | Create nodes | 参考 |
启用 | Enable nodes | 参考 |
禁用节点 | Disable nodes | 参考 |
获取节点信息 | Get information on nodes | 参考 |
其他
- Put server in shutdown mode (quiet down/safe exit/exit)
- Create/Delete/Update folders
- Get builded last git version information
更新日志
加入我们
qq群 - 87208295