# @ckeditor/ckeditor5-dev-ci 中文文档

规范地址：https://npmcn.com/package/%40ckeditor/ckeditor5-dev-ci/

版本：63\.1\.3
npm 元数据更新时间：2026-11-09T07:49:34.993Z
中文译文更新时间：2026-11-09T23:21:12.238Z
软件包许可：GPL-2\.0-or-later

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

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

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

- 包体积（解压后）：63.3 kB，26 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=26\.10\.0
- 运行依赖：3 个
- 首次发布：2022-12-20T11:57:50.531Z
- 最新版本发布：2026-11-09T07:49:34.746Z
- 近 30 天下载量：11217（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：222（近 12 个月 80 个）

## 中文简介

用于各种连续融合服务的Utils.

## 安装

```sh
npm install @ckeditor/ckeditor5-dev-ci
```

也可以使用：`pnpm add @ckeditor/ckeditor5-dev-ci`、`yarn add @ckeditor/ckeditor5-dev-ci`、`bun add @ckeditor/ckeditor5-dev-ci`

## README

# 5 CI 公用事业

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-dev-ci.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-ci) [![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5-dev.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-dev?branch=master)

用户数 [电脑编辑 5](https://ckeditor.com/) CI建设.

包含从 Circle CI 和 GitHub 动作工作流程发送 Slack 通知的工具 .

## 可用的脚本

这些命令接受环境变量和命令行参数的组合. 当值来自 CI 环境或敏感(像符等)时,环境变量优先. 当值为静态或局部到给定寄存器时,命令行参数优先.

> \[尖叫声\] Tokens作为环境变量被传递,以避免在 shell 历史, CI 日志,或共享配置文件中暴露出敏感的证书.

-   ⚙️ **`ckeditor5-dev-ci-circle-disable-auto-cancel-builds`**
    
    禁用 _“自动终止冗余工作流程”_ 选项. 在发布过程中有用地防止CircleCI取消发布所触发的工作流程,承诺自己.
    
    **环境变量:**
    
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于认证.
    
    **参数:**
    
    -   `--organization` ——GitHub组织名称.
    -   `--repository` —— GitHub 仓库名.
-   ⚙️ **`ckeditor5-dev-ci-circle-enable-auto-cancel-builds`**
    
    启用 _“自动终止冗余工作流程”_ 选项. 应在发布工作流程使用此选项后使用 `ckeditor5-dev-ci-circle-disable-auto-cancel-builds` 剧本.
    
    **环境变量:**
    
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于认证.
    
    **参数:**
    
    -   `--organization` ——GitHub组织名称.
    -   `--repository` —— GitHub 仓库名.
-   ⚙️ **`ckeditor5-dev-ci-circle-workflow-notifier`**
    
    等待所有的工作在 **当前 CircleCI 工作流程** 以完成(成功或出错),然后运行最终命令("通知"). 打算作为一个 **专职工作** 在你的工作流程中。 脚本本身处理等待 - 您通常不添加 `requires` 这工作.
    
    **环境变量:**
    
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于认证.
    
    **CircleCI 提供的变量 :**
    
    -   `CIRCLE_WORKFLOW_ID` ——当前工作流程标识.
    -   `CIRCLE_JOB` ——当前工作名称.
    
    **参数:**
    
    -   `--task` ——在结尾执行的命令;默认: `pnpm ckeditor5-dev-ci-notify-circle-status`。 。 。 .
    -   `--ignore` ——等待时忽略的任务名(可重复;可以多次传递).
    
    **行为:**
    
    -   返回瞬变圆 CI API 出错至 **5次尝试** 带有 **10s 延迟** 尝试之间.
    -   对不可重试的 API 错误( 例如: 无效的令牌或错误的工作流程 ID) 立即失败 .
    -   如果瞬间出错持续存在,则退出时会发出明确的信息,要求手动核实工作流程结果.
-   ⚙️ **`ckeditor5-dev-ci-is-job-triggered-by-member`**
    
    证明:a **CircleCI 批准任务** 由属于指定的 GitHub 团队的用户批准. 使用CircleCI和GitHub APIs来对照团队成员来检查批准者.
    
    **环境变量:**
    
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于认证.
    -   `CKE5_GITHUB_TOKEN` —— GitHub 令牌用于查询团队成员.
    
    **CircleCI 提供的变量 :**
    
    -   `CIRCLE_WORKFLOW_ID` ——当前工作流程标识.
    
    **参数:**
    
    -   `--job` ——负责核实的审批工作名称.
    -   `--organization` ——GitHub组织名称.
    -   `--team` —— GitHub 团队名称( slug) 以验证对手.
-   ⚙️ **`ckeditor5-dev-ci-is-workflow-restarted`**
    
    检查当前 CircleCI 工作流程是否已经 **重新启动**。 。 。 . 如果检测到重启,则脚本会以零出站代码退出,允许管道有条件地继续.
    
    **环境变量:**
    
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于认证.
    
    **CircleCI 提供的变量 :**
    
    -   `CIRCLE_WORKFLOW_ID` ——当前工作流程的ID(由CircleCI设置).
-   ⚙️ **`ckeditor5-dev-ci-notify-circle-status`**
    
    发送 Slack 通知,总结当前 CircleCI 构建/工作流程状态 . 对于失败的构建, 请通过 GitHub API( 使用私人寄存器的工作) 获取执行作者 .
    
    **环境变量:**
    
    -   `CKE5_GITHUB_TOKEN` - GitHub 符号与 `repo` 范围,用于获取执行作者.
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于API调用.
    -   `CKE5_SLACK_WEBHOOK_URL` ——Webhook URL进入Slack频道接收通知.
    
    **CircleCI 提供的变量 :**
    
    -   `CIRCLE_BRANCH` ——目前建筑的编号.
    -   `CIRCLE_PROJECT_REPONAME` ——仓库名.
    -   `CIRCLE_PROJECT_USERNAME` - 组织/用户名称.
    -   `CIRCLE_SHA1` - 提交当前建筑的SHA.
    -   `CIRCLE_WORKFLOW_ID` ——当前工作流程标识.
    
    **参数:**
    
    -   `--pipeline-id` 圆形值( M) `<< pipeline.number >>` 参数([更多信息](https://circleci.com/docs/guides/orchestrate/pipeline-variables/#pipeline-values)) (中文(简体) ).
    -   `--trigger-repository-slug` —— 说 `<org>/<repo>` 构建承诺 URL `--trigger-commit-hash`。当管道通过另一个仓库被触发时有用.
    -   `--trigger-commit-hash` ——承诺SHA构建承诺URL. 当管道通过不同的存储器被触发时有用 .
    -   `--hide-author` —— 说 `"true"`编号 :`"false"` 把作者藏在斯莱克.
-   ⚙️ **`ckeditor5-dev-ci-notify-github-actions-status`**
    
    发送 Slack 通知, 总结当前 GitHub 动作工作流程运行 . 设计为从门将(或专用工作)调用 `if: failure()`;脚本在发送通知前不检查工作流程状态. 通过 GitHub API( 使用私有寄存器的工作) 获取任务作者和工作流程运行启动时间 .
    
    **环境变量:**
    
    -   `CKE5_GITHUB_TOKEN` - GitHub 符号与 `repo` 范围,用于获取承诺作者和工作流程运行元数据.
    -   `CKE5_SLACK_WEBHOOK_URL` ——Webhook URL进入Slack频道接收通知.
    
    **GitHub 提供的变量 :**
    
    -   `GITHUB_REPOSITORY` —— 说 `<owner>/<repo>` 当前工作流程.
    -   `GITHUB_REF_NAME` - 触发工作流程的分支或标签名称.
    -   `GITHUB_SHA` 提交当前运行的 SHA .
    -   `GITHUB_RUN_ID` ——当前工作流程运行的标识.
    -   `GITHUB_RUN_ATTEMPT` —— 说 _(备选)_ 运行尝试编号; 当大于 `1`。 。 。 .
    -   `GITHUB_WORKFLOW` —— 说 _(备选)_ 显示当前工作流程的名称 .
    -   `GITHUB_SERVER_URL` —— 说 _(备选)_ 服务器 URL; 默认为 `https://github.com`。 。 。 .
    -   `GITHUB_API_URL` —— 说 _(备选)_ API 基础 URL; 默认为 `https://api.github.com`。 。 。 .
    
    **参数:**
    
    -   `--trigger-repository-slug` —— 说 `<org>/<repo>` 构建承诺 URL `--trigger-commit-hash`。当工作流程通过不同的存储器被触发时有用.
    -   `--trigger-commit-hash` ——承诺SHA构建承诺URL. 当工作流程通过不同的存储器被触发时有用 .
    -   `--hide-author` —— 说 `"true"`编号 :`"false"` 把作者藏在斯莱克.
-   ⚙️ **`ckeditor5-dev-ci-trigger-circle-build`**
    
    触发 a **新 CircleCI 管道** 用于指定仓库. 通常用于启动现有工作流程的发布或后续管道.
    
    **环境变量:**
    
    -   `CKE5_CIRCLE_TOKEN` —— CircleCI API 令牌用于认证.
    
    **CircleCI 提供的变量 :**
    
    -   `CIRCLE_BRANCH` ——目前已加工管线的吉特分支.
    -   `CIRCLE_SHA1` ——全力投入目前已加工管线的SHA.
    
    **参数:**
    
    -   `--slug` - 储存弹(`org/name`新管道将在那里开始.
    -   `--trigger-repository-slug` —— 说 _(备选)_ 存储弹( R)`org/name`这引发了新的管道. 如果匹配, 可以省略 `--slug`。 。 。 .
    -   `--release-branch` —— 说 _(备选)_ 领导放行过程的分会.
    -   `--pipeline-definition-id` —— 说 _(备选)_ GitHub App 管道定义 ID. 在提供时,指定管道 定义被触发,而不是项目默认的 OAuth 管道.
-   ⚙️ **`ckeditor5-dev-ci-trigger-snyk-scan`**
    
    为当前分支发布 Snyk 代码和依赖快照 . 它配置 Snyk CLI 以使用欧盟端点和所提供的组织,然后运行 `snyk code test` 财务报告和审定财务报表 `snyk monitor` 命令.
    
    **环境变量:**
    
    -   `SNYK_TOKEN` ——用于认证的斯奈克令牌.
    -   `DEBUG` —— 说 _(备选)_ 设定时, 附加 `-d` 改为 `snyk code test` 财务报告和审定财务报表 `snyk monitor` 用于动词输出,并删除 `--silent` 从 `pnpm` 引证.
    
    **CircleCI 提供的变量 :**
    
    -   `CIRCLE_BRANCH` -吉特分行作为斯奈克的 `target-reference`。 。 。 .
    
    **参数:**
    
    -   `--depth` —— 说 _(备选)_ 检测深度传递到 `snyk monitor` 作为 `--detection-depth`默认为 `2`。 。 。 .
    -   `--exclude` —— 说 _(可选,可重复)_ 附加目录或文件名以排除斯奈克的依赖快照. 使用多次, 例如 `--exclude=build --exclude=dist`。所提供的数值是: **合并** 内置默认值( n)`external`, (中文(简体) ), `tests`, (中文(简体) ), `node_modules`, (中文(简体) ), `release`, (中文(简体) ), `scripts`) (中文(简体) ).
    -   `--organization` - Snyk组织 身份或子弹.
    
    **行为:**
    
    -   总是排除 `external`, (中文(简体) ), `tests`, (中文(简体) ), `node_modules`, (中文(简体) ), `release` 财务报告和审定财务报表 `scripts` 从依赖性快照检测。 通过 `--exclude` 与这些默认合并(重复被忽略).
    -   通行证 `--detection-depth` (默认 : `2`改为: `snyk monitor` 以限制 Snyk 对显示文件的深度扫描,从而避免深度嵌入引起的性能问题 `node_modules` 树.
    -   接受退出代码 `1` 从 `snyk code test`,所以当发现弱点时,代码快照仍然被发布.
    -   需要退出代码 `0` 从 `snyk monitor`,因为任何其他代码意味着依赖快照没有被创建.

## 更改日志

见 [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-ci/CHANGELOG.md) 文档.

## 许可证

根据下列规定获得许可证: [GNU 通用公共许可证版本 2 或稍后版本](http://www.gnu.org/licenses/gpl.html)请检查date=中的日期值 (帮助) `LICENSE.md` 文档.

## 常见问题

### @ckeditor/ckeditor5-dev-ci 是什么？

用于各种连续融合服务的Utils\.

### 如何安装 @ckeditor/ckeditor5-dev-ci？

在项目目录运行 npm install @ckeditor/ckeditor5-dev-ci，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ckeditor5-dev-ci-trigger-snyk-scan、ckeditor5-dev-ci-notify-circle-status、ckeditor5-dev-ci-trigger-circle-build、ckeditor5-dev-ci-is-workflow-restarted、ckeditor5-dev-ci-circle-workflow-notifier、ckeditor5-dev-ci-is-job-triggered-by-member、ckeditor5-dev-ci-notify-github-actions-status、ckeditor5-dev-ci-circle-enable-auto-cancel-builds、ckeditor5-dev-ci-circle-disable-auto-cancel-builds，可以用 npx ckeditor5-dev-ci-trigger-snyk-scan 直接运行。

### @ckeditor/ckeditor5-dev-ci 支持 TypeScript 吗？

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

### @ckeditor/ckeditor5-dev-ci 支持 ESM 还是 CommonJS？

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

### @ckeditor/ckeditor5-dev-ci 需要什么版本的 Node\.js？

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

### @ckeditor/ckeditor5-dev-ci 可以商用吗？

@ckeditor/ckeditor5-dev-ci 使用 GPL-2\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以兼容的 GPL 许可开源。仅在内部使用、不对外分发时不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @ckeditor/ckeditor5-dev-ci 的下载量有多少？

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

### @ckeditor/ckeditor5-dev-ci 还在维护吗？

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