# CHANGELOG变更日志生成工具 **Repository Path**: consolelog/wang-changelog ## Basic Information - **Project Name**: CHANGELOG变更日志生成工具 - **Description**: 由rust编写的CHANGELOG变更日志生成工具 - **Primary Language**: Rust - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-03-13 - **Last Updated**: 2025-04-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # wang-changelog ## 介绍 这是一个生成 `CHANGELOG.md` 变更日志的工具。 下载地址: ## 快速开始 - 在git提交信息中，按照规范输入您的信息，例如: - `git commit -m "feat: 这是一个feature功能"` - `git commit -m "fix: 这是一个bug修复"` - 执行 `wlog` 生成 `CHANGELOG.md`，生成信息如下: ```markdown # 更新日志 该日志由wang-changelog生成，详情见 https://gitee.com/consolelog/wang-changelog ## v1.0.0 (2024-04-01) ### 🐞 Bug Fixes | Bug 修复 * 这是一个bug修复 ### ✨ Features | 新功能 * 这是一个feature功能 ``` ## 详细说明 版本生成规则按照约定式提交规范: - fix: 开头的会更新patch版本号，从v2.3.5到v2.3.6 - feat: 开头的会更新minor版本号，从v2.3.5到v2.4.0 - feat!: 开头的会更新major版本号，从v2.3.5到v3.0.0 选项: | 参数 | 说明 | 示例 | |---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --version 或
-v | 指定版本号，除非已经存在，否则会无视规则使用这个版本。 | 例如："wlog -v v1.3.5"执行之后，当前是v2.6.5，新生成的是v1.3.5 | | --beta 或
--alpha 或
--tag beta 或
-t alpha | 指定生成tag类型。
内置beta和alpha两个tag，其它的需要用-t手动指定 | 例如："wlog --beta"执行之后，当前是v1.0.0，新生成的就是v1.0.0-beta.0，下次是v1.0.0-beta.1
例如："wlog -t test"执行之后，当前是v1.0.0，新生成的是v1.0.0-test.0，下次是v1.0.0-test.1
例如："wlog --beta"执行之后，当前是v1.0.0-beta.0，新生成的就是v1.0.0-beta.1，下次是v1.0.0-beta.2 | | --path 或
-p | 指定git路径，在哪个路径读取git提交记录。 | 例如："wlog -p ~/Downloads/test-folder"，注意这个路径下必须有.git文件夹，否则会报错。 | | --output 或
-o | 指定CHANGELOG.md输出路径，在哪个路径生成changelog.md
默认生成的名称为：CHANGELOG.md。 | 例如："wlog -o ~/Downloads/log.md" | | --skipCommit 或
-sc | 只生成changelog，不进行git提交 | | | --revCommit 或
-rc | 反转提交信息的顺序。
默认是从上到下，时间点从最旧到最新，加上这个参数之后会反过来 | | | --config-file 或
-f | 指定配置文件路径。
可以指定生成的title、description，以及不同类型对应的文字。
默认会读取当前目录的".versionrc"、
".versionrc.json"、 ".version.json"这些文件。 | [链接](https://gitee.com/consolelog/wang-changelog/raw/master/tests/test_config/config2.json) | ## 路线图 - [ ] 加入版本变更对比地址，显示该版本、该提交都改变了哪些代码。例如这种链接: - [ ] 针对不同架构自动修改版本号，比如node自动修改package.json中的版本号、java自动修改maven中的版本号、rust自动修改cargo.toml中的版本号等 - [ ] 同一个版本中，合并重复提交信息 ## 其它 测试覆盖率报告: