changie 预处理release changelog 工具

changie 提供了比较友好的changelogs 说明

changelog 的一些原则

  • 记住日志是写给人而非机器的
  • 每个版本都应该有独立的入口
  • 同类改动应该分组放置
  • 不同版本应分别设置链接
  • 新版本在前,旧版本在后
  • 应包括每个版本的发布日期
  • 注明是否遵守语义化版本规范

changie 提供的一些changes 类型

  • Added 新特性的
  • Changed 修改存在的函数
  • Deprecated 废弃,未来可能会移除的
  • Removed 移除的一些特性
  • Fixed bug 修复
  • Security 安全问题

说明

changie 是一个很不错的changelogs 工具,实际上不支持可以和git 集成,我们进行文档处理也是可以的, 同时changie 也是支持对于格式以及类型的自定义的,后边简单说明下使用

参考资料

https://changie.dev/
https://github.com/miniscruff/changie
https://github.com/olivierlacan/keep-a-changelog/blob/main/CHANGELOG.md
https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html#Style-of-Change-Logs

posted on   荣锋亮  阅读(17)  评论(0编辑  收藏  举报

相关博文:
阅读排行:
· 全程不用写代码,我用AI程序员写了一个飞机大战
· DeepSeek 开源周回顾「GitHub 热点速览」
· 记一次.NET内存居高不下排查解决与启示
· MongoDB 8.0这个新功能碉堡了,比商业数据库还牛
· .NET10 - 预览版1新功能体验(一)
历史上的今天:
2022-05-26 dremio 的 joust 的作用
2022-05-26 dremio 21.1 分布式存储单机测试的一种方法
2018-05-26 nexus && minio s3 存储私有镜像
2017-05-26 java 二维码生成(vcard)
2017-05-26 Gixy Nginx 配置分析工具

导航

< 2025年3月 >
23 24 25 26 27 28 1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31 1 2 3 4 5
点击右上角即可分享
微信分享提示