从源码到发布：github-changes的版本控制与Semver排序功能

从源码到发布：github-changes的版本控制与Semver排序功能

【免费下载链接】github-changesGenerate a changelog based on merged pull requests or commit messages项目地址: https://gitcode.com/gh_mirrors/gi/github-changes

github-changes是一款强大的工具，能够根据合并的拉取请求或提交消息生成变更日志，帮助开发者轻松实现版本控制与Semver排序功能。

🌟 核心功能概览

github-changes提供了丰富的版本控制特性，让项目的版本管理变得简单高效。通过该工具，你可以根据拉取请求或提交消息自动生成详细的变更日志，清晰记录每个版本的更新内容。

📌 版本控制基础

项目的版本信息在package.json文件中定义，当前版本为2.0.3。该工具支持多种与版本相关的操作，如指定标签名称、生成特定标签的变更日志等。

在bin/index.js中，你可以看到版本相关的命令行选项：

• -n, --tag-name [name]：指定即将发布的标签名称，默认为"upcoming"
• --for-tag [tag]：仅获取指定标签的变更

🚀 Semver排序功能解析

Semver（语义化版本）排序是github-changes的一项重要功能。通过--order-semver选项，你可以按照语义化版本规则对标签进行排序，而不是默认的标签日期排序。

这项功能在bin/index.js中实现，核心代码如下：

// order by semver then commit date var tagCompare = 0; if (a.tag.name === b.tag.name) tagCompare = 0; else if (a.tag.name === opts.tagName) tagCompare = 1; else if (b.tag.name === opts.tagName) tagCompare -1; else tagCompare = semver.compare(a.tag.name, b.tag.name); return (tagCompare) ? tagCompare : compareSign * (moment(a.commit.committer.date) - moment(b.commit.committer.date));

这段代码使用了semver库来比较版本号，确保标签按照语义化版本规则正确排序。

💡 实用操作指南

生成完整变更日志

要生成完整的变更日志，只需在项目根目录运行以下命令：

npx github-changes

默认情况下，变更日志将输出到CHANGELOG.md文件中。

生成特定标签的变更日志

如果你只想生成某个特定标签的变更日志，可以使用--for-tag选项：

npx github-changes --for-tag v2.0.0

按Semver排序标签

要按照语义化版本规则对标签进行排序并生成变更日志，使用--order-semver选项：

npx github-changes --order-semver

比较两个标签之间的变更

使用--between-tags选项可以比较两个标签之间的变更：

npx github-changes --between-tags v1.0.0...v2.0.0

📝 版本发布流程

项目提供了release.sh脚本，简化了版本发布流程。该脚本接受一个semver值（major、minor、patch）作为参数，自动更新版本号、创建标签并推送变更。

使用方法如下：

./release.sh minor

🎯 总结

github-changes通过强大的版本控制和Semver排序功能，为开发者提供了便捷的变更日志生成工具。无论是小型项目还是大型开源项目，都能从中受益，让版本管理变得更加规范和高效。

通过合理利用--order-semver、--for-tag等选项，你可以轻松生成符合Semver规范的变更日志，清晰记录项目的演进历程，为团队协作和用户体验提供有力支持。

【免费下载链接】github-changesGenerate a changelog based on merged pull requests or commit messages项目地址: https://gitcode.com/gh_mirrors/gi/github-changes