发布流程
我们来讨论一下 Docusaurus 是如何处理版本、发布和破坏性变更的。
信息
这个专题对于那些比较难以升级的高度定制网站来说尤为重要。
语义化版本
Docusaurus 版本基于 major.min.patch
模式,尊重语义版本规范。
尊重语义版本很重要,因为:
- 可以保证小版本升级比较简单,只要你只使用公开 API
- 符合前端生态的传统
- 发布新的大版本时,有机会完整地记录破坏性变更
- 发布新的大版本/小版本时,有机会通过博客介绍新功能
备注
发布 Docusaurus 2.0 花了很长很长时间。 从现在开始,Docusaurus 会更经常地发布新的大版本。 一般来说,每 2~4 个月都会发一个新的大版本。
我们不会对大版本号太有敬畏之心,但仍然会把破坏性更改放在一起,避免大版本发布太频繁。
大版本
每次发布破坏性变更,major
版本号都会递增。
每次发布新的大版本时,我们会发布:
- 一篇博文,包括主要功能介绍、重要 bug 修复、破坏性变更、和升级指南。
- 完整的更新记录
提示
要清楚理解我们会将哪些作为破坏性变更,请阅读我们的公开 API 部分。
小版本
每次发布向后兼容的重要变化时,minor
版本号都会递增。
每次发布新的小版本时,我们会发布:
- 一篇博文,包括主要功能介绍和重要 bug 修复
- 完整的更新记录
提示
如果你只使用我们的公开 API,那升级应该很简单!
补丁版本
每次发布 bug 修复时,patch
版本号都会递增。
每次发布新的补丁版本时,我们会发布:
- 完整的更新记录