Node.js Jenkins API 使用文档

本文档将详细介绍如何使用 Node.js Jenkins API，帮助用户安装、配置以及使用该 API 与 Jenkins 服务器进行交互。

1. 安装指南

首先，确保已经安装了 Node.js。然后，使用以下命令安装 Jenkins API：

npm install jenkins-api

2. 项目的使用说明

初始化 Jenkins 客户端

在开始使用 API 之前，需要初始化 Jenkins 客户端。以下是初始化 Jenkins 客户端的几种方式：

const jenkinsapi = require('jenkins-api');

// 不使用认证
var jenkins = jenkinsapi.init("http://jenkins.yoursite.com");

// 使用用户名/密码
var jenkins = jenkinsapi.init("http://username:[e-mail]");

// 使用 API Token
var jenkins = jenkinsapi.init('https://username:[e-mail]');

// 密码需要 %-编码
const { URL } = require('url');
const jenkinsUrl = new URL('https://[e-mail]');
jenkinsUrl.password = 'some_weirdPASSWORD123!@#$%^&*()~`\\/;\'';
var jenkins = jenkinsapi.init(jenkinsUrl.href);

构建任务

以下是一些常用的构建任务操作：

触发构建

jenkins.build('job-in-jenkins', { token: 'jenkins-token' }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

使用参数触发构建

jenkins.build_with_params('job-in-jenkins', { depth: 1, <param>:<value>, token: 'jenkins-token' }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

停止构建

jenkins.stop_build('job-in-jenkins', 'build-number', { token: 'jenkins-token' }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

获取控制台输出

jenkins.console_output('job-in-jenkins', 'buildname', { depth: 1, <param>:<value> }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

获取构建信息

jenkins.build_info('job-in-jenkins', 'build-number', { depth: 1, <param>:<value> }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

获取最后一次构建信息

jenkins.last_build_info('job-in-jenkins', { depth: 1, <param>:<value> }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

获取最后一次完成的构建信息

jenkins.last_completed_build_info('job-in-jenkins', { depth: 1, <param>:<value> }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

获取所有构建信息

jenkins.all_builds('job-in-jenkins', { depth: 1, <param>:<value> }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

获取测试结果/报告

jenkins.test_result('job-in-jenkins', 'build-number', { depth: 1, <param>:<value> }, function(err, data) {
  if (err) { return console.log(err); }
  console.log(data);
});

3. 项目API使用文档

以下是项目提供的 API 方法及其用途：

• jenkins.build: 触发 Jenkins 任务构建。
• jenkins.build_with_params: 使用参数触发 Jenkins 任务构建。
• jenkins.stop_build: 停止正在进行的 Jenkins 任务构建。
• jenkins.console_output: 获取 Jenkins 任务的控制台输出。
• jenkins.build_info: 获取 Jenkins 任务构建信息。
• jenkins.last_build_info: 获取最后一次 Jenkins 任务构建信息。
• jenkins.last_completed_build_info: 获取最后一次完成的 Jenkins 任务构建信息。
• jenkins.all_builds: 获取 Jenkins 任务所有构建信息。
• jenkins.test_result: 获取 Jenkins 任务测试结果/报告。

4. 项目安装方式

项目安装方式已在“安装指南”部分说明。使用以下命令安装 Jenkins API：

npm install jenkins-api

以上是 Node.js Jenkins API 的使用说明，希望对您有所帮助。如有任何疑问或建议，请随时联系我们。