产品更新日志维护

2022-11-11 | 10分钟 | yrobot | 工程化,更新,日志,产品,版本

为什么需要更新日志

更好配合 git tag 和 npm version 进行 版本管理,便于开发者回想各个版本都编写了哪些代码,并基于日志和 git 操作回溯相应版本进行分支开发。

便于用户了解 版本 变动(新功能和修复)

怎么进行更新日志管理

更新日志文件名

CHANGELOG.md

文件内容规范

  1. Changelog为文档标题,并配以简短说明
  2. 利用[Unreleased]对当前正在处理的变动进行记录
  3. 按照时间降序排列,以[$VERSION] - YYYY-MM-DD的格式作为标题对一个版本进行记录
  4. 所有变动根据 变动类型 进行归类

变动类型

  • Added: 新添加的功能
  • Changed: 对现有功能的变更
  • Deprecated: 已经不建议使用,即将移除的功能
  • Removed: 已经移除的功能
  • Fixed: 对 bug 的修复
  • Security: 对安全性的改进

内容示例

# Changelog

This is a changelog demo.

## [Unreleased]

### Added

- Add a new feature

### Fixed

- Fix xxx bug

## [1.0.0] - 2022-11-11

### Added

- add i18n support: english and chinese

### Changed

- mixpanel track more scene:
  - parse time
  - preview device
  - global error logs

参考文献

如何维护更新日志