CHANGELOG.md 中文文档教程

Question

changelog.md

How does it work

• Get last version from git tag, if no tags it defaults to 0.0.0
• Get the commits since last version
• Prompt user to enter the type of each commit
• Infer the new version from the types of all commits
• Generate markdown string from commits and prompt answers
• Create or prepend to CHANGELOG.md and update package.json version field
• Commits changes and create new git tag

Install

$ yarn global add changelog.md

Usage

$ changelog

Recipes

Commit types

• patch: Bug fixes
• minor: Backward-compatible updates
• major: Introducing breaking changes
• ignore: Do not include this commit in changelog

除了在提示中选择 ignore 以从 changelog 中排除提交外，以 ignore: 开头的提交消息也将被排除。

你也可以使用type: message这样的格式来预定义commit类型，它们会被转换为我们使用的commit类型：

semantic type	description	commit type	0.y.z
chore	changes to build process	ignore
docs	documentation only changes	ignore
feat	a new feature	minor	patch
fix	bug fix	patch
refactor	code refactor	patch
style	code style changes	ignore
test	add missing tests	ignore
breaking	introduce breaking changes	major	minor
perf	performance improvements	patch
tweaks	don't know how to describe	patch

注意：在0.yz版本中，major更改会影响 y，其他更改和补丁会影响 z。 所以在这种情况下你永远无法达到 1.0.0 是吗？ 然后明确指定下一个版本的版本，例如：changelog 1.0.0

对于 tweaks: subject，一条消息只有 tweaks 或 < code>tweak 也将是一个补丁。

您不必在提交消息中使用这些类型，因为您可以在实际运行 changelog 时一一设置它们（仅适用于 CHANGELOG.md，不会更新提交本身）。

Work with npm publish

# made some changes to your code...
$ git commit -am "feat: change the world"
$ npm test
$ changelog
$ git push --follow-tags
$ npm publish

Projects using this

• SAO: ⚔️ Futuristic scaffolding tool.
• docute: Effortlessly documentation done right.
• welcome to add your project here…

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

changelog.md © EGOIST，根据 MIT 许可证。
由 EGOIST 在贡献者 (list) 的帮助下创作和维护。

egoistian.com · GitHub @EGOIST · 推特 @remrinrin