productsupcom/jenkins-php-api

通过JSON API使用PHP控制Jenkins的库

2.0.0 2021-11-15 10:15 UTC

This package is auto-updated.

Last update: 2024-09-19 22:46:33 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'

始终有两种方法来实例化一个项目并获取你想要的数据

  1. 直接使用类(new Job('myjob', $jenkins))。在这种情况下,你必须首先实例化Jenkins,并将其作为第二个构造函数参数传递。
  2. 使用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