如何 semver 版本控制文档更新？

Posted 2023-03-07

【中文标题】如何 semver 版本控制文档更新？

【英文标题】：How to semver versioning documentation update?

【发布时间】：2019-02-21 16:38:05

【问题描述】：

我正在编写一个 REST API 包装器并提交了一个重要的文档更改。根据semver，我应该如何处理？由于源代码没有更改，我应该更新我的次要/补丁版本号还是完全忽略更新？

【参考方案1】：

这取决于文档更改。如果您没有突然说“此错误不是您可以依赖的功能并且最终将被修复”之类的话，您可能会更改补丁级别。换句话说，如果您没有很多客户依赖于一些以前未记录的功能，现在显然被标记为错误，那么它就是一个补丁。但是，如果新文档的要点有效地改变了大部分客户的世界，您可能希望将其视为一项重大变化。

通常，在这种情况下，您会在文档中使用明确标记的弃用语言作为小更改发布，然后发布删除未记录的功能或错误的重大更改，以及对文档的相关更改。

如果这些都不适用于您的文档更改，则属于补丁级别更改。