# @form8ion/github-workflows-core 中文文档 规范地址：https://npmcn.com/package/%40form8ion/github-workflows-core/ 版本：6\.0\.0 npm 元数据更新时间：2026-03-15T14:09:46.747Z 中文译文更新时间：2026-11-15T08:18:32.848Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40form8ion/github-workflows-core 原文对照：https://npmcn.com/package/%40form8ion/github-workflows-core/?lang=original 项目主页：https://npm.im/@form8ion/github-workflows-core 源码仓库：https://github.com/form8ion/github-workflows-core ## 关键信息（来自 npm 元数据） - 包体积（解压后）：27.8 kB，25 个文件 - 模块格式：ES Module - TypeScript 类型：未声明 - Node.js 要求：^20\.19\.0 \|\| \>=22\.14\.0 - 运行依赖：1 个 - 首次发布：2022-05-13T02:51:22.678Z - 最新版本发布：2026-03-15T14:09:46.449Z - 近 30 天下载量：15619（2026-10-16 至 2026-11-14，npm 官方下载统计） - 已发布版本数：22（近 12 个月 6 个） ## 中文简介 管理 github 工作流程的 form8ion 插件的核心功能 ## 安装 ```sh npm install @form8ion/github-workflows-core ``` 也可以使用：`pnpm add @form8ion/github-workflows-core`、`yarn add @form8ion/github-workflows-core`、`bun add @form8ion/github-workflows-core` ## README # 工作流程- 核心 管理 github 工作流程的 form8ion 插件的核心功能 [![Node CI Workflow Status](https://img.shields.io/github/actions/workflow/status/form8ion/github-workflows-core/node-ci.yml.svg?branch=master&logo=github)](https://github.com/form8ion/github-workflows-core/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster) [![Codecov](https://img.shields.io/codecov/c/github/form8ion/github-workflows-core?logo=codecov)](https://codecov.io/github/form8ion/github-workflows-core) ![SLSA Level 2](https://slsa.dev/images/gh-badge-level2.svg) ## 目录 - [使用量](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-usage) - [安装](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-installation) - [示例](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-example) - [导入](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-import) - [执行](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-execute) - [API 密码](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-api) - [`scaffoldCheckoutStep`](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-scaffoldcheckoutstep) - [`scaffoldNodeSetupStep`](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-scaffoldnodesetupstep) - [`versionDeterminedBy` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-versiondeterminedby-string-required) - [`scaffoldDependencyInstallationStep`](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-scaffolddependencyinstallationstep) - [`scaffoldVerificationStep`](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-scaffoldverificationstep) - [捐款](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-contributing) - [依赖关系](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-dependencies) - [核查](https://npmcn.com/package/%40form8ion/github-workflows-core/#readme-verification) ## 使用量 [![MIT license](https://img.shields.io/github/license/form8ion/github-workflows-core.svg?logo=opensourceinitiative)](https://npmcn.com/package/%40form8ion/github-workflows-core/LICENSE) [![npm](https://img.shields.io/npm/v/@form8ion/github-workflows-core?logo=npm)](https://www.npmjs.com/package/@form8ion/github-workflows-core) [![Try @form8ion/github-workflows-core on RunKit](https://badge.runkitcdn.com/@form8ion/github-workflows-core.svg)](https://npm.runkit.com/@form8ion/github-workflows-core) ![node](https://img.shields.io/node/v/@form8ion/github-workflows-core?logo=node.js) ### 安装 ```sh $ npm install @form8ion/github-workflows-core --save-prod ``` ### 示例 #### 导入 ```javascript import { scaffoldCheckoutStep, scaffoldNodeSetupStep, scaffoldDependencyInstallationStep, scaffoldVerificationStep, loadWorkflowFile, writeWorkflowFile, workflowFileExists, renameWorkflowFile } from '@form8ion/github-workflows-core'; ``` #### 执行 ```javascript const projectRoot = process.cwd(); (async () => { scaffoldCheckoutStep(); scaffoldNodeSetupStep({versionDeterminedBy: 'nvmrc'}); scaffoldDependencyInstallationStep(); scaffoldVerificationStep(); if (await workflowFileExists({projectRoot, name: 'existing-workflow-name'})) { await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'}); } await writeWorkflowFile({projectRoot, name: 'workflow-name', config: {}}); await renameWorkflowFile({projectRoot, oldName: 'existing-workflow-name', newName: 'new-workflow-name'}); })(); ``` ### API 密码 #### `scaffoldCheckoutStep` 脚手架,以定义一个步骤的细节,以便在 GitHub 工作流程 #### `scaffoldNodeSetupStep` 脚手架,用于定义一个步骤的细节,以便在 a GitHub 工作流程 以单个选项对象作为参数,包含: ##### `versionDeterminedBy` **字符串** (单位:千美元)_所需经费_(中文(简体) ) 用于已配置步骤的节点版本的来源 。 有效的选项是 `nvmrc` 或者说 `matrix` #### `scaffoldDependencyInstallationStep` 脚手架,用于定义在 GitHub 中安装依赖性步骤的细节 工作流程 #### `scaffoldVerificationStep` 脚手架以定义执行核查步骤的细节 ## 捐款 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org/) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com/) ### 依赖关系 ```sh $ nvm install $ npm install ``` ### 核查 ```sh $ npm test ``` ## 常见问题 ### @form8ion/github-workflows-core 是什么？ 管理 github 工作流程的 form8ion 插件的核心功能 ### 如何安装 @form8ion/github-workflows-core？ 在项目目录运行 npm install @form8ion/github-workflows-core，或使用 pnpm add / yarn add / bun add。 ### @form8ion/github-workflows-core 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/form8ion\_\_github-workflows-core 是否存在。 ### @form8ion/github-workflows-core 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @form8ion/github-workflows-core 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js ^20\.19\.0 \|\| \>=22\.14\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @form8ion/github-workflows-core 可以商用吗？ @form8ion/github-workflows-core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @form8ion/github-workflows-core 的下载量有多少？ 根据 npm 官方下载统计，@form8ion/github-workflows-core 在 2026/10/16 – 2026/11/14 这 30 天内被下载 15,619 次，日均约 521 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @form8ion/github-workflows-core 还在维护吗？ 最新版本 6\.0\.0 发布于 2026/03/15（8 个月前）；至今共发布 22 个版本，其中过去 12 个月发布了 6 个；首次发布于 2022/05/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。