# @cypress/github-commit-status-check 中文文档

规范地址：https://npmcn.com/package/%40cypress/github-commit-status-check/

版本：1\.5\.0
npm 元数据更新时间：2025-10-27T19:15:49.071Z
中文译文更新时间：2026-11-11T10:02:54.854Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40cypress/github-commit-status-check
原文对照：https://npmcn.com/package/%40cypress/github-commit-status-check/?lang=original
项目主页：https://github.com/cypress-io/release-automations/tree/master/packages/github-commit-status-check#readme
源码仓库：https://github.com/cypress-io/release-automations

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：26.3 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2019-04-23T20:53:41.862Z
- 最新版本发布：2019-07-03T17:47:21.423Z
- 近 30 天下载量：2261（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

设置 GitHub 承诺状态

## 安装

```sh
npm install @cypress/github-commit-status-check
```

也可以使用：`pnpm add @cypress/github-commit-status-check`、`yarn add @cypress/github-commit-status-check`、`bun add @cypress/github-commit-status-check`

## README

# @ cypress/ github- 承诺- status- 检查

> 基于 GH 应用安装设置 GitHub 承诺状态的小工具

此用途被GitHub App设备使用. 因此,您的环境应该有以下3个认证信息作为环境变量:

-   `GH_APP_ID`
-   `GH_INSTALLATION_ID`
-   `GH_PRIVATE_KEY`

这个 `GH_PRIVATE_KEY` 是基础64编码的私钥。 例如,如果将私人"pem"文件的内容复制到剪贴板中,可以从终端执行"pbpaste QQ Base64 QQ pbcopy",并在剪贴板中得到编码字符串.

跟往常一样,我建议在当地使用 [作为-a](https://github.com/bahmutov/as-a) 函数.

## 使用

主要通过模块 API 使用,参见 [标准/指数.ts](https://npmcn.com/package/%40cypress/github-commit-status-check/src/index.ts)

### 设置承诺检查

```typescript
import { setCommitStatus } from '@cypress/github-commit-status-check'
await setCommitStatus({
  // bunch of options
})
```

有本脚本 [src/bin/ set-承诺-状态.ts](https://npmcn.com/package/%40cypress/github-commit-status-check/src/bin/set-commit-status.ts) 从命令行参数读取选项。 例如,如果环境变量被存储在块中 `set-status` 在你身边 [作为-a](https://github.com/bahmutov/as-a) 设置,然后:

```shell
$ as-a set-status npm run set-commit-status -- --repo ...
```

### 添加对犯罪的评论

```shell
$ as-a set-status npm run add-commit-comment -- --repo ...
```

## 调试

以环境变量运行 `DEBUG=@cypress/github-commit-status-check` 查看更多日志消息

## 常见问题

### @cypress/github-commit-status-check 是什么？

设置 GitHub 承诺状态注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @cypress/github-commit-status-check？

在项目目录运行 npm install @cypress/github-commit-status-check，或使用 pnpm add / yarn add / bun add。

### @cypress/github-commit-status-check 支持 TypeScript 吗？

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

### @cypress/github-commit-status-check 支持 ESM 还是 CommonJS？

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

### @cypress/github-commit-status-check 可以商用吗？

@cypress/github-commit-status-check 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cypress/github-commit-status-check 的下载量有多少？

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

### @cypress/github-commit-status-check 还在维护吗？

最新版本 1\.5\.0 发布于 2019/07/04（7 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/04/24。作者已将其标记为弃用，新项目建议寻找替代方案。