KnowledgeVault-API-Gateway
Facilitates robust interaction with the Yuque knowledge management platform's backend services. It enables comprehensive lifecycle management for textual content artifacts and user identity data, encompassing creation, retrieval, modification, and archival operations. Furthermore, it exposes capabilities for querying performance metrics and statistical summaries pertaining to designated information repositories.
Author

HenryHaoson
Quick Info
Actions
Tags
自动流程配置指南 (GitHub Actions)
流程概览
本代码仓库已预设以下自动化执行序列(GitHub Actions workflows):
- 版本迭代器 (version-bump): 负责自动递增和更新 Node Package Manager (npm) 模块的版本标识符。
- NPM 仓库推送 (npm-publish): 负责自动执行构建步骤并将最终产物部署至 npmjs.com 注册表。
操作指南
版本迭代器序列
您可以通过 GitHub Web 界面手动启动此自动化流程:
- 导航至本仓库的 "Actions" 标签页。
- 选取名为 "版本更新" 的流程定义。
- 点击 "Run workflow" 按钮。
- 明确指定所需的版本升级范式(如 patch、minor 或 major 级别)。
- 确认操作,点击 "Run workflow"。
该序列将自动执行以下任务:
- 修正 package.json 文件中的版本号标记。
- 生成相应的 Git 版本标签 (tag)。
- 提交所有修改并推送至远程存储库。
NPM 仓库推送序列
此部署流程将在以下事件中被自动触发:
- 任何新的 GitHub 版本 (Release) 创建事件。
- 手动启动请求。
若需手动触发部署过程: 1. 访问 "Actions" 界面。 2. 选择 "发布 NPM 包" 流程。 3. 点击 "Run workflow" 按钮。 4. 再次点击 "Run workflow" 以确认执行。
密钥配置:NPM 认证凭证
为了确保 NPM 发布流程能够成功认证并写入注册表,必须在 GitHub 仓库的安全配置中设置一个专用的访问令牌:
- 在 npmjs.com 网站上生成一个新的访问令牌 (Token),路径参考:https://www.npmjs.com/settings/[YourUsername]/tokens
- 在 GitHub 仓库中,进入 "Settings" (设置) 菜单,随后导航至 "Secrets and variables" > "Actions"。
- 选择 "New repository secret" (新建仓库密钥)。
- 密钥名称必须精确设置为
NPM_TOKEN,其对应值即为您刚才生成的 npm 访问令牌。 - 点击 "Add secret" 完成保存。
