🚀 GitHub 操作工作流使用说明
本说明文档主要介绍了 GitHub 操作工作流的相关内容,包括工作流概述、使用方法以及必要的配置步骤,帮助你更好地利用这些工作流实现 npm 包的版本更新和发布。
🚀 快速开始
✨ 工作流概述
本仓库配置了以下 GitHub 操作工作流:
- 版本更新 (version-bump):用于自动更新 npm 包的版本号。
- NPM 包发布 (npm-publish):用于自动构建并发布 npm 包到 npmjs.com。
📦 使用方法
版本更新工作流
此工作流允许你通过 GitHub 界面手动触发版本更新,具体步骤如下:
- 进入仓库的 "Actions" 选项卡。
- 选择 "版本更新" 工作流。
- 点击 "运行工作流" 按钮。
- 选择版本更新类型(patch、minor 或 major)。
- 点击 "运行工作流" 确认。
工作流将自动完成以下操作:
- 更新
package.json 中的版本号。
- 创建对应的 Git 标签。
- 提交并推送所有更改。
NPM 包发布工作流
此工作流在以下情况下自动触发:
- 当创建新的 GitHub 发布时。
- 手动触发时。
要手动触发发布流程,可按以下步骤操作:
- 进入仓库的 "Actions" 选项卡。
- 选择 "发布 NPM 包" 工作流。
- 点击 "运行工作流" 按钮。
- 点击 "运行工作流" 确认。
🔧 配置 npm 发布令牌
要使 NPM 发布工作流正常工作,需要在 GitHub 仓库中配置 NPM 令牌,具体步骤如下:
- 在 npm 网站上生成访问令牌 (https://www.npmjs.com/settings/[用户名]/tokens)。
- 在 GitHub 仓库中,进入 "设置" > "秘密和变量" > "操作"。
- 点击 "新建仓库秘密"。
- 名称填写
NPM_TOKEN,值填写你的 npm 访问令牌。
- 点击 "添加秘密" 保存。