# @elastic/github-checks-reporter 中文文档

规范地址：https://npmcn.com/package/%40elastic/github-checks-reporter/

版本：0\.0\.20-b3
npm 元数据更新时间：2026-09-25T13:38:41.328Z
中文译文更新时间：2026-11-13T11:09:45.048Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40elastic/github-checks-reporter
原文对照：https://npmcn.com/package/%40elastic/github-checks-reporter/?lang=original
项目主页：https://github.com/elastic/github-checks-reporter#readme
源码仓库：https://github.com/elastic/github-checks-reporter

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：211 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：6 个
- 首次发布：2019-04-11T16:48:32.949Z
- 最新版本发布：2019-06-25T19:54:14.675Z
- 近 30 天下载量：7162（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 0 个）

## 中文简介

通过 GitHub 检查提供表达式 CI 反馈的任务包

## 安装

```sh
npm install @elastic/github-checks-reporter
```

也可以使用：`pnpm add @elastic/github-checks-reporter`、`yarn add @elastic/github-checks-reporter`、`bun add @elastic/github-checks-reporter`

## README

# github-checks-reporter (英语). 请检查date=中的日期值 (帮助)

通过 GitHub 检查提供表达式 CI 反馈的任务包

## 使用量

`yarn run github-checks-reporter ${task title} ${...command and command args}`

实例

`yarn run github-checks-reporter jest node scripts/jest`

## 设置

`yarn add --dev github-xyz` (包名将更新)

github-checks-reporter 依赖于一些环境变量,以便 调用 GitHub API -

| 数值 | 默认环境变量 |
| --- | --- |
| 应用程序 | (歌声) |
| 重排积 | ghprbGh仓库 |
| 承诺 | ghprb 实际承诺 |
| 构建Url | 布隆迪语 URL |

不同的环境变量可以通过 `github_checks_api.json` 配置文件位于工程根中 .

示例

```json
{
  "appId": 26774,
  "envVars": {
    "appKey": "KIBANA_CI_REPORTER_KEY"
  }
}
```

## 如何运作

github- checks-reporter 获取任务标题和 shell 命令及其参数 和:

-   通过 GitHub 检查 API 创建检查
-   执行命令
-   存储和传递日志数据和退出代码
-   基于退出代码更新检查, 将日志数据附加到检查中

## 常见问题

### @elastic/github-checks-reporter 是什么？

通过 GitHub 检查提供表达式 CI 反馈的任务包

### 如何安装 @elastic/github-checks-reporter？

在项目目录运行 npm install @elastic/github-checks-reporter，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 github-checks-reporter，可以用 npx github-checks-reporter 直接运行。

### @elastic/github-checks-reporter 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/elastic\_\_github-checks-reporter 是否存在。

### @elastic/github-checks-reporter 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @elastic/github-checks-reporter 可以商用吗？

@elastic/github-checks-reporter 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @elastic/github-checks-reporter 的下载量有多少？

根据 npm 官方下载统计，@elastic/github-checks-reporter 在 2026/10/14 – 2026/11/12 这 30 天内被下载 7,162 次，日均约 239 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @elastic/github-checks-reporter 还在维护吗？

最新版本 0\.0\.20-b3 发布于 2019/06/26（7 年前）；至今共发布 37 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/04/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。