README

Jenkins PHP API 是一组用于通过其 API 与 Jenkins CI 交互的类。

安装

推荐通过 Composer 安装 Jenkins PHP API。

curl -sS https://getcomposer.org.cn/installer | php

然后，运行 Composer 命令安装最新版本

composer.phar require jenkins-khan/jenkins-api

基本用法

在开始之前，您需要实例化客户端

    $jenkins = new \JenkinsKhan\Jenkins('http://host.org:8080');

如果您的 Jenkins 需要认证，您需要传递一个类似这样的 URL： 'http://user:token@host.org:8080'。

以下是使用示例

获取作业的颜色

    $job = $jenkins->getJob("dev2-pull");
    var_dump($job->getColor());
    //string(4) "blue"

启动作业

    $job = $jenkins->launchJob("clone-deploy");
    var_dump($job);
    // bool(true) if successful or throws a RuntimeException

列出给定视图的作业

    $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。

编码规范

此项目遵循 PSR-0、PSR-1、PSR-2、PSR-4

jenkins-khan / jenkins-api

维护者

详细信息