@basic-genomics/hivtrace-viz 1.2.6 → 1.3.0

package/README.md

@@ -155,6 +155,68 @@ ls -la node_modules/@basic-genomics/hivtrace-viz
 # 应显示：xxx -> ../../../hivtrace-viz
 ```
 
+## 自动发布 (CI/CD)
+
+项目已配置 GitHub Actions 实现全自动版本管理和 npm 发布。
+
+### 配置步骤
+
+#### 1. 获取 npm 访问令牌
+
+1. 登录 [npmjs.com](https://www.npmjs.com/)
+2. 右上角头像 → **Access Tokens** → **Generate New Token**
+3. 选择 **Automation** 类型
+4. 复制 Token（只显示一次）
+
+#### 2. 配置 GitHub Secrets
+
+1. 进入仓库 **Settings** → **Secrets and variables** → **Actions**
+2. 点击 **New repository secret**
+3. 添加：
+   - **Name**: `NPM_TOKEN`
+   - **Value**: 上一步获取的 token
+
+#### 3. 确认 npm 组织权限
+
+确保你的 npm 账号拥有 `@basic-genomics` 组织的发布权限。首次发布需手动执行：
+
+```bash
+npm login
+yarn build
+npm publish --access public
+```
+
+### 发布流程
+
+配置完成后，发布流程**全自动**：
+
+```
+提交代码到 main 分支（遵循 Conventional Commits）
+        ↓
+release-please 自动创建 Release PR
+        ↓
+合并 PR → 自动创建 GitHub Release
+        ↓
+自动发布到 npm
+```
+
+### Commit 规范
+
+| 格式 | 版本变更 | 示例 |
+|------|----------|------|
+| `feat: xxx` | Minor (1.2.0 → 1.3.0) | `feat: 添加簇追踪功能` |
+| `fix: xxx` | Patch (1.2.0 → 1.2.1) | `fix: 修复上下文菜单定位` |
+| `feat!: xxx` | Major (1.2.0 → 2.0.0) | `feat!: 重构 API 接口` |
+| `chore/docs/style` | 不触发发布 | `docs: 更新 README` |
+
+### 手动测试发布
+
+在 GitHub Actions 中可手动触发 dry-run 测试：
+
+1. 仓库 → **Actions** → **Publish to npm**
+2. 点击 **Run workflow**
+3. 勾选 **是否仅测试发布流程**
+
 ## 项目结构
 
 ```