# @e2e-dev/github 中文文档

规范地址：https://npmcn.com/package/%40e2e-dev/github/

版本：0\.4\.5
npm 元数据更新时间：2026-11-13T13:27:38.386Z
中文译文更新时间：2026-11-13T13:33:08.224Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40e2e-dev/github
原文对照：https://npmcn.com/package/%40e2e-dev/github/?lang=original
项目主页：https://github.com/e2e-inc/e2e/tree/main/packages/github#readme
源码仓库：https://github.com/e2e-inc/e2e

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

- 包体积（解压后）：49.7 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.22\.3 \|\| \>=24\.8\.0
- 运行依赖：0 个
- peer 依赖：e2e \>=0\.15\.0 \<1
- 首次发布：2026-09-28T18:46:27.261Z
- 最新版本发布：2026-11-13T13:27:38.033Z
- 近 30 天下载量：130789（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 48 个）

## 中文简介

E2e的 GitHub 报告员: 每跑一次拖取请求注释, 来自 GitHub Actions

## 安装

```sh
npm install @e2e-dev/github
```

也可以使用：`pnpm add @e2e-dev/github`、`yarn add @e2e-dev/github`、`bun add @e2e-dev/github`

## README

# 翻译:

GitHub 的记者 [`e2e`](https://www.npmjs.com/package/e2e)。 。 。 . 从 GitHub 动作中,每次运行都会变成一个拉出请求注释,编辑于 重新运行时,同一文本会出现在工作摘要中.

```bash
npm install --save-dev @e2e-dev/github
```

```ts
import type { E2EConfig } from 'e2e';
import { web } from '@e2e-dev/web';
import { github } from '@e2e-dev/github';

export default {
  targets: [{ engine: web(), app: { url: 'http://localhost:3000' } }],
  reporters: ['list', github()],
} satisfies E2EConfig;
```

这工作需要 `permissions: pull-requests: write` 和运行的台阶 `e2e` 需求 `GITHUB_TOKEN: ${{ github.token }}` 联合国 `env`矩阵复制品 一份工作通过 `key` 所以他们的意见是分开的 `e2e explore` 运行 保留自己的评论。 当记者不能 文章(另一个CI,一个推,一个叉子的只读符号)在一则摘要中说为什么 排行并永不更改跑出代码.

完整文档生活于 [e2e.com/docs/github (中文(简体) )](https://e2e.com/docs/github)。 。 。 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @e2e-dev/github 是什么？

E2e的 GitHub 报告员: 每跑一次拖取请求注释, 来自 GitHub Actions

### 如何安装 @e2e-dev/github？

在项目目录运行 npm install @e2e-dev/github，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：e2e（\>=0\.15\.0 \<1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @e2e-dev/github 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @e2e-dev/github 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @e2e-dev/github 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.22\.3 \|\| \>=24\.8\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @e2e-dev/github 可以商用吗？

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

### @e2e-dev/github 的下载量有多少？

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

### @e2e-dev/github 还在维护吗？

最新版本 0\.4\.5 发布于 2026/11/13（今天）；至今共发布 48 个版本，其中过去 12 个月发布了 48 个；首次发布于 2026/09/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。