【发布时间】:2021-04-30 04:07:19
【问题描述】:
Keep a Changelog 是一种广泛使用的约定,它提供了一些关于在通过 VCS 管理的存储库中维护 CHANGELOG.md 文件的准则。
当涉及到一个独特版本的多次提交时,我怀疑它应该如何工作。
由于它的文本描述了“应该对相同类型的更改进行分组”,并且它自己的 repo CHANGELOG.md 文件带来了以下内容:
...
## [1.0.0] - 2017-06-20
### Added
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
- Version navigation.
- Links to latest released version in previous versions.
- "Why keep a changelog?" section.
- "Who needs a changelog?" section.
...
但是,Semmantic Versioning 2.0 遵循相同的准则,它定义:
...
6. Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.
7. Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.
...
所以我知道每次提交引入错误修复或新功能都应分别增加 PATCH 或 MINOR 版本。
是这样吗?
【问题讨论】:
-
我不清楚你指的是什么冲突。最好的做法是与新功能分开发布错误修复,但不是必需的。如果两者都有,那么规范很清楚,如果您制作次要版本并重置补丁。如果您没有添加任何新功能/API,则只能使用补丁版本。
标签: repository conventions release-management semantic-versioning changelog