How I maintain release notes for curl
8 months ago
- #automation
- #documentation
- #release-notes
- 清晰全面的文档是优秀产品的基础。
- 详细且信息丰富的版本说明对于交付高质量产品至关重要。
- curl项目使用脚本维护版本说明和文档。
- maketgz是生成发布压缩包的基础脚本，其容器化版本称为dmaketgz。
- verify-release脚本确保压缩包内容源自git仓库和发布工具。
- release-notes.pl通过解析自上次「已同步」提交后的git日志生成RELEASE-NOTES。
- 需人工审核版本说明以分类变更条目并移除无关内容。
- release-notes.pl的清理功能会按字母序排列修复项并删除孤立引用。
- contributors.sh提取并格式化贡献者名单以供纳入RELEASE-NOTES。
- delta脚本提供当前仓库状态与最近发布版本的统计对比。
- 更新后的RELEASE-NOTES会以「RELEASE-NOTES: synced」消息提交，用于自动化追踪。
- 当前正在编写的版本说明可在curl官网查看。
- git别名「latest」可帮助列出上次版本说明更新后的变更。