首页
/ changelog-maker 的项目扩展与二次开发

changelog-maker 的项目扩展与二次开发

2025-06-07 10:29:31作者:凤尚柏Louis

项目的基础介绍

changelog-maker 是一个用于生成 Git 仓库更新日志的工具,它能够将 Git 提交记录转换为 CHANGELOG.md 文件,以标准的 Markdown 格式展示。该项目基于 Node.js 开发,旨在帮助项目维护者自动化地管理更新日志,使项目历史变更更加清晰。

项目的核心功能

changelog-maker 的核心功能包括:

  • 自动收集自上次打标签以来或指定范围内的 Git 提交记录。
  • 从提交信息中提取并链接到相应的 GitHub Pull Request。
  • 根据提交信息中的标签(如 semver-major、semver-minor 等)分类提交记录。
  • 将收集到的信息格式化为 Markdown 格式,并输出到标准输出或文件中。

项目使用了哪些框架或库?

该项目主要使用了以下框架或库:

  • Node.js:作为项目的基础运行环境。
  • GitHub API:用于获取 Pull Request 的元数据,如标签和链接。

项目的代码目录及介绍

项目的代码目录结构如下:

  • .github/:包含项目的 GitHub 工作流文件。
  • .gitignore:指定 Git 忽略的文件。
  • CHANGELOG.md:项目更新日志文件。
  • LICENSE.md:项目许可证文件。
  • README.md:项目说明文件。
  • auth.js:处理 GitHub 认证的脚本。
  • changelog-maker.js:项目主脚本,包含核心逻辑。
  • collect-commit-labels.js:收集提交记录中的标签。
  • commit-to-list.js:将提交记录转换为列表。
  • commit-to-output.js:输出格式化的提交记录。
  • find-matching-prs.js:查找与提交记录匹配的 Pull Request。
  • format.js:处理格式化逻辑。
  • group-commits.js:根据提交信息中的前缀对提交记录进行分组。
  • groups.js:定义分组逻辑。
  • package.json:项目配置文件。
  • process-commits.js:处理提交记录。
  • reverts.js:处理回滚提交。
  • test.js:项目测试脚本。

对项目进行扩展或者二次开发的方向

  • 支持更多 Git 托管平台:目前 changelog-maker 主要支持 GitHub,可以考虑扩展支持其他 Git 托管平台,如 GitLab、Bitbucket 等。
  • 增强格式化功能:可以扩展更多自定义格式化选项,允许用户自定义输出日志的样式。
  • 集成更多元数据处理:如增加对提交记录中的代码改动统计、贡献者统计等功能。
  • 优化性能:对于大型项目,优化数据收集和处理性能,减少内存消耗。
  • 增加交互性:为命令行工具增加交互式界面,帮助用户更直观地配置和使用。
  • 多语言支持:目前项目输出为英文,可以增加多语言支持,以适应不同国家和地区的用户需求。
登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
118
207
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
528
404
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
392
37
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
251
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.02 K
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
42
40
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
357
341
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
583
41