jenkins

通过 REST API 与 Jenkins CI/CD 服务器交互。当您需要触发构建、检查构建状态、查看控制台输出、管理作业或监视 Jenkins 节点和队列时使用。支持通过环境变量部署到不同的Jenkins实例。

# Jenkins

Interact with Jenkins CI/CD server through REST API.

## Required environment variables

- `JENKINS_URL` (example: `https://jenkins.example.com`)
- `JENKINS_USER` (your Jenkins username)
- `JENKINS_API_TOKEN` (API token from Jenkins user settings)

## List jobs

```bash
node {baseDir}/scripts/jenkins.mjs jobs
node {baseDir}/scripts/jenkins.mjs jobs --pattern "deploy-*"
```

## Trigger build

```bash
node {baseDir}/scripts/jenkins.mjs build --job "my-job"
node {baseDir}/scripts/jenkins.mjs build --job "my-job" --params '{"BRANCH":"main","ENV":"dev"}'
```

## Check build status

```bash
node {baseDir}/scripts/jenkins.mjs status --job "my-job"
node {baseDir}/scripts/jenkins.mjs status --job "my-job" --build 123
node {baseDir}/scripts/jenkins.mjs status --job "my-job" --last
```

## View console output

```bash
node {baseDir}/scripts/jenkins.mjs console --job "my-job" --build 123
node {baseDir}/scripts/jenkins.mjs console --job "my-job" --last --tail 50
```

## Stop build

```bash
node {baseDir}/scripts/jenkins.mjs stop --job "my-job" --build 123
```

## View queue

```bash
node {baseDir}/scripts/jenkins.mjs queue
```

## View nodes

```bash
node {baseDir}/scripts/jenkins.mjs nodes
```

## Notes

- URL and credentials are variables by design for cross-environment deployment.
- API responses are output as JSON.
- For parameterized builds, use `--params` with JSON string.

---

## 中文说明

# Jenkins

通过 REST API 与 Jenkins CI/CD 服务器交互。

## 必需的环境变量

- `JENKINS_URL`（示例：`https://jenkins.example.com`）
- `JENKINS_USER`（你的 Jenkins 用户名）
- `JENKINS_API_TOKEN`（来自 Jenkins 用户设置的 API 令牌）

## 列出作业

```bash
node {baseDir}/scripts/jenkins.mjs jobs
node {baseDir}/scripts/jenkins.mjs jobs --pattern "deploy-*"
```

## 触发构建

```bash
node {baseDir}/scripts/jenkins.mjs build --job "my-job"
node {baseDir}/scripts/jenkins.mjs build --job "my-job" --params '{"BRANCH":"main","ENV":"dev"}'
```

## 检查构建状态

```bash
node {baseDir}/scripts/jenkins.mjs status --job "my-job"
node {baseDir}/scripts/jenkins.mjs status --job "my-job" --build 123
node {baseDir}/scripts/jenkins.mjs status --job "my-job" --last
```

## 查看控制台输出

```bash
node {baseDir}/scripts/jenkins.mjs console --job "my-job" --build 123
node {baseDir}/scripts/jenkins.mjs console --job "my-job" --last --tail 50
```

## 停止构建

```bash
node {baseDir}/scripts/jenkins.mjs stop --job "my-job" --build 123
```

## 查看队列

```bash
node {baseDir}/scripts/jenkins.mjs queue
```

## 查看节点

```bash
node {baseDir}/scripts/jenkins.mjs nodes
```

## 说明

- 出于跨环境部署的设计，URL 和凭据为变量。
- API 响应以 JSON 形式输出。
- 对于参数化构建，使用 `--params` 配合 JSON 字符串。