CLI更新日志模板

CLI更新日志模板

模板说明

本文档为RAILWISE-CLI版本更新日志的标准模板。所有CLI版本发布必须按照此模板编写更新日志，确保用户能够快速了解版本变更内容和影响。

模板结构

# RAILWISE-CLI v{主版本}.{次版本}.{修订版本} 更新日志

> **发布日期**: {YYYY-MM-DD}
> **版本类型**: {major | minor | patch}
> **兼容性**: {兼容/不兼容/需要迁移}
> **下载地址**: [GitHub Releases](https://github.com/railwise/cli/releases/tag/v{版本号})

---

## 版本概述

{简要描述本版本的主要变更和核心价值，不超过100字}

---

## 新增功能 (Features)

### {功能名称}

- **功能描述**: {简要描述功能用途}
- **适用场景**: {适用场景说明}
- **使用方式**: {简要使用说明或命令示例}
- **相关文档**: [文档链接]

### {功能名称}

...

---

## 功能改进 (Improvements)

### {改进项名称}

- **改进内容**: {具体改进描述}
- **改进前**: {改进前的行为或限制}
- **改进后**: {改进后的行为或优势}
- **影响范围**: {受影响的功能或模块}

---

## 问题修复 (Bug Fixes)

### {问题编号}: {问题描述}

- **问题现象**: {用户遇到的具体现象}
- **影响范围**: {受影响的功能或版本}
- **修复方案**: {修复的技术方案}
- **验证方式**: {用户如何验证修复}

---

## 性能优化 (Performance)

- **优化项**: {优化内容}
- **优化效果**: {性能提升数据，如"数据处理速度提升40%"}
- **适用场景**: {哪些场景下效果最明显}

---

## 依赖更新 (Dependencies)

| 依赖包 | 旧版本 | 新版本 | 更新原因 |
|--------|--------|--------|---------|
| {包名} | {旧版本} | {新版本} | {更新原因} |

---

## 破坏性变更 (Breaking Changes)

:::warning 重要提示
以下变更可能导致现有脚本或工作流不兼容，请仔细阅读迁移指南。
:::

### {变更项名称}

- **变更内容**: {具体变更描述}
- **影响范围**: {受影响的用户或功能}
- **迁移指南**: {如何迁移到新版}
- **废弃时间**: {旧功能废弃时间（如适用）}

---

## 安全更新 (Security)

- **安全漏洞**: {漏洞描述}
- **CVE编号**: {CVE编号（如适用）}
- **影响版本**: {受影响的版本范围}
- **修复方案**: {修复措施}
- **建议操作**: {用户应采取的措施}

---

## 文档更新 (Documentation)

- [新增文档: {文档标题}](链接)
- [更新文档: {文档标题}](链接)
- [删除文档: {文档标题}](链接)

---

## 已知问题 (Known Issues)

- {问题描述}: {临时解决方案或预计修复时间}

---

## 升级指南

### 自动升级

```bash
npm update -g @railwise/cli

手动升级

npm uninstall -g @railwise/cli
npm install -g @railwise/cli@{版本号}

验证升级

railwise --version
# 应输出: railwise/{版本号}

---

反馈与支持

• 问题反馈: GitHub Issues
• 技术支持: support@railwise.cn
• 社区讨论: Discussions

---

版本历史

版本	日期	类型	说明
v{上一版本}	{日期}	{类型}	{简要说明}
v{当前版本}	{日期}	{类型}	{简要说明}

## 版本号规则

CLI采用语义化版本控制（SemVer）：

| 版本类型 | 版本号变化 | 说明 | 示例 |
|---------|-----------|------|------|
| 主版本 | X.0.0 | 不兼容的API变更 | 1.0.0 → 2.0.0 |
| 次版本 | 0.X.0 | 向下兼容的功能新增 | 1.1.0 → 1.2.0 |
| 修订版本 | 0.0.X | 向下兼容的问题修复 | 1.1.0 → 1.1.1 |

## 变更类型标签

| 标签 | 含义 | 使用场景 |
|------|------|---------|
| `feat` | 新功能 | 新增命令、参数、功能 |
| `fix` | 问题修复 | 修复Bug、错误 |
| `perf` | 性能优化 | 提升速度、降低资源 |
| `docs` | 文档更新 | 更新文档、注释 |
| `style` | 格式调整 | 代码格式、风格 |
| `refactor` | 重构 | 代码重构，不影响功能 |
| `test` | 测试 | 新增或更新测试 |
| `chore` | 构建/工具 | 构建脚本、依赖更新 |
| `security` | 安全 | 安全漏洞修复 |
| `breaking` | 破坏性变更 | 不兼容的变更 |

## 编写规范

1. **清晰简洁**：每条变更描述不超过50字
2. **用户视角**：从用户角度描述变更，避免技术术语
3. **影响明确**：明确说明变更的影响范围和兼容性
4. **示例具体**：提供具体的命令示例或配置代码
5. **迁移完整**：破坏性变更必须提供完整迁移指南

---

## 相关文档

- [WorkWise更新说明模板](update-workwise-release.md)
- [TSM版本发布说明](update-tsm-release.md)
- [通用更新流程指南](update-general-process.md)

<!-- AI语义标签: 更新日志, CLI, 版本管理, 模板, 编写规范 -->