# @chronus/github 中文文档

规范地址：https://npmcn.com/package/%40chronus/github/

版本：1\.2\.1
npm 元数据更新时间：2026-09-11T16:02:46.614Z
中文译文更新时间：2026-11-09T15:23:55.224Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：73.1 kB，67 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：7 个
- 首次发布：2024-03-03T22:32:06.835Z
- 最新版本发布：2026-09-11T16:02:46.244Z
- 近 30 天下载量：25380（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 6 个）

## 中文简介

克罗纳斯

## 安装

```sh
npm install @chronus/github
```

也可以使用：`pnpm add @chronus/github`、`yarn add @chronus/github`、`bun add @chronus/github`

## README

# Chronus Github 插件

此插件用于将克罗纳斯与Github集成.

提供下列功能:

### Github 增强变化日志

更改日志条目将链接到添加它们的 pr .

将此添加到 `.chronus/config.yaml`

```yaml
changelog: ["@chronus/github/changelog", { repo: "<user>/<repo>" }]
```

结果实例 :

```md
## 0.16.0

### Bug Fixes

- [#365](https://github.com/timotheeguerin/chronus/pull/365) Fix `--exclude` not respected for `version`, `status` commands

### Features

- [#367](https://github.com/timotheeguerin/chronus/pull/367) Reverse order of change kinds in changelog. As changes are recommneded to be ordered from least disruptive to most in the config.
```

### 创建 Github 注释

命令生成一个注释,让您知道PR中有什么变化,并给出一个链接,直接在浏览器中添加更改日志.

```bash
chronus-github get-pr-comment --out ./comment-out/comment.json
```

**这个必须用在 `@chronus/github-pr-commenter` 软件包,然后按 github 描述的 2 步进程发布 [https://securitylab.github.com/research/github-actions- prevent-pwn-requests/\* 互联网档案馆的存檔,存档日期2014-12-21](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/*)\* 联合国**

### 创建 Github 发布

从出版摘要中创建 github 发布, 从 changelog.md 中取回更改日志 .

```bash
# Chronus publish the package and create a release summary
chronus publish --access public --report-summary ./publish-summary.json
# Chronus github uses the summary to create the github release
chronus-github create-releases --repo <user>/<name> --publish-summary ./publish-summary.json
```

## 常见问题

### @chronus/github 是什么？

克罗纳斯

### 如何安装 @chronus/github？

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

### @chronus/github 支持 TypeScript 吗？

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

### @chronus/github 支持 ESM 还是 CommonJS？

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

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

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

### @chronus/github 可以商用吗？

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

### @chronus/github 的下载量有多少？

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

### @chronus/github 还在维护吗？

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