# @alchemy\.run/github 中文文档

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

版本：2\.0\.0-beta\.85
npm 元数据更新时间：2026-11-02T21:06:58.936Z
中文译文更新时间：2026-11-05T18:25:04.783Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：914 kB，384 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：effect ^4\.1\.0，alchemy 2\.0\.0-beta\.85
- 首次发布：2026-10-21T16:58:02.694Z
- 最新版本发布：2026-11-02T21:06:58.580Z
- 近 30 天下载量：74612（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

GitHub 寄存器, 秘密和 Alchemy 的网友.

## 安装

```sh
npm install @alchemy.run/github
```

也可以使用：`pnpm add @alchemy.run/github`、`yarn add @alchemy.run/github`、`bun add @alchemy.run/github`

## README

# @alchemy

GitHub 为 [炼金术](https://alchemy.run/)。在您的 CI 部署的基础设施中, 在同一 TypeScript 程序中, 宣告寄存器、 动作秘密和变量、 环境、 网点和分支保护 .

```sh
npm install alchemy @alchemy.run/github effect
```

拥有变量的存储器,其部署工作流程需要:

```typescript
// alchemy.run.ts
import * as Alchemy from "alchemy";
import * as GitHub from "@alchemy.run/github";
import * as Effect from "effect/Effect";

export default Alchemy.Stack(
  "MyRepos",
  {
    providers: GitHub.providers(),
    state: Alchemy.localState(),
  },
  Effect.gen(function* () {
    const repo = yield* GitHub.Repository("api", {
      owner: "my-org",
      name: "api",
      description: "API service",
      autoInit: true,
      deleteBranchOnMerge: true,
    });

    yield* GitHub.Variables({
      owner: "my-org",
      repository: "api",
      variables: { AWS_REGION: "us-east-1" },
    });

    yield* GitHub.Environment("production", {
      owner: "my-org",
      repository: "api",
      name: "production",
      reviewers: { teams: ["platform"] },
    });

    return { url: repo.htmlUrl };
  }),
);
```

其他提供者的产出直接流入:通过角色ARN `@alchemy.run/aws` 作为变量,或 Axiom 摄入标志作为秘密, 他们保持同步 在每次部署.

## 学多点

-   [GitHub 在炼金术上, 运行](https://alchemy.run/github)
-   [设置](https://alchemy.run/github/setup)
-   [动作机密和变量](https://alchemy.run/github/actions-config)
-   [仓库事件](https://alchemy.run/github/events)

## 常见问题

### @alchemy\.run/github 是什么？

GitHub 寄存器, 秘密和 Alchemy 的网友\.

### 如何安装 @alchemy\.run/github？

在项目目录运行 npm install @alchemy\.run/github，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（^4\.1\.0）、alchemy（2\.0\.0-beta\.85）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @alchemy\.run/github 支持 TypeScript 吗？

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

### @alchemy\.run/github 支持 ESM 还是 CommonJS？

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

### @alchemy\.run/github 可以商用吗？

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

### @alchemy\.run/github 的下载量有多少？

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

### @alchemy\.run/github 还在维护吗？

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