wkse / jenkins-php-api
通过 JSON API 使用 PHP 控制 Jenkins 的库
0.1.13
2016-04-05 06:00 UTC
Requires
- php: >=5.4.0
- ext-curl: *
This package is not auto-updated.
Last update: 2024-09-20 19:20:43 UTC
README
此版本的 Jenkins PHP API 基于 https://github.com/jenkins-khan/jenkins-php-api。它比原始版本更面向对象(意味着更清晰的 API),并且具有一些额外的功能。
它包装了 Jenkins API 的 API 调用。
入门指南
首先,您需要实例化连接
$jenkins = new Jenkins('http://host.org:8080');
如果您的 Jenkins 需要认证,您需要传递一个类似这样的 URL:'http://user:token@host.org:8080'
。
总是有两种方法来实例化一个项目并获取您想要的数据
- 直接使用类(
new Job('myjob', $jenkins)
)。在这种情况下,您必须首先实例化 Jenkins 并将其作为第二个构造函数参数传递。 - 使用 Jenkins 的方法:
(new Jenkins('myurl'))->getJob('myjob')
获取作业的颜色
$job = $jenkins->getJob("dev2-pull");
var_dump($job->getColor());
//string(4) "blue"
启动作业
将启动作业并立即返回
$job = $jenkins->getJob("clone-deploy")->launch();
将启动作业并等待作业完成
$job = $jenkins->getJob("clone-deploy")->launchAndWait();
列出给定视图中的作业
$view = $jenkins->getView('madb_deploy');
foreach ($view->getJobs() as $job) {
var_dump($job->getName());
}
//string(13) "altlinux-pull"
//string(8) "dev-pull"
//string(9) "dev2-pull"
//string(11) "fedora-pull"
列出构建及其状态
$job = $jenkins->getJob('dev2-pull');
foreach ($job->getBuilds() as $build) {
var_dump($build->getNumber());
var_dump($build->getResult());
}
//int(122)
//string(7) "SUCCESS"
//int(121)
//string(7) "FAILURE"
检查 Jenkins 是否可用
var_dump($jenkins->isAvailable());
//bool(true);
有关更多信息,请参阅 Jenkins API。