git-conventional-commits

git-conventional-commits

规范化Git提交信息的自动化工具

Git Conventional Commits是一款专注于规范化Git提交信息的开源工具。它提供配置初始化、版本确定、更新日志生成和提交信息检查等核心功能。用户可自定义提交类型和范围,通过npx命令便捷使用。该工具支持与pre-commit框架集成,也可手动设置Git钩子,确保提交符合规范。它为开发团队提供了一种改善版本管理和文档的有效方法。

GitConventional Commits版本控制提交规范自动化工具Github开源项目

Git 约定式提交 星标趋势

npm

[!提示] 也可以看看 Git 约定式提交备忘单

更新日志

查看 CHANGELOG.md

使用方法

npx git-conventional-commits <命令>

命令

ℹ 在命令后添加帮助参数 -h 可列出所有可用选项

  init [选项]                               创建配置文件模板 `git-conventional-commits.yaml`
  version [选项]                            根据约定式提交确定版本
  changelog [选项]                          根据约定式提交生成更新日志
  commit-msg-hook [选项] <commit-msg-file>  检查提交消息是否符合约定式格式

首次使用

  • 运行 npx git-conventional-commits init
  • 根据需要调整 配置文件 git-conventional-commits.yaml

配置文件

git-conventional-commits.yaml 示例

--- convention: commitTypes: - feat - fix - perf - refactor - style - test - build - ops - docs - merge commitScopes: [] releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]* changelog: commitTypes: - feat - fix - perf - merge includeInvalidCommits: true commitScopes: [] commitIgnoreRegexPattern: "^WIP " headlines: feat: 功能 fix: 错误修复 perf: 性能优化 merge: 合并 breakingChange: 重大变更 commitUrl: https://github.com/qoomon/git-conventional-commits/commit/%commit% commitRangeUrl: https://github.com/qoomon/git-conventional-commits/compare/%from%...%to%?diff=split issueRegexPattern: "#[0-9]+" issueUrl: https://github.com/qoomon/git-conventional-commits/issues/%issue%
  • convention
    • commitTypes 预期的提交类型数组
      • 对意外类型显示警告
      • 如果未设置或为空,则禁用提交类型验证
      • 例如:["feat", "fix", "doc", "style"]
    • commitScopes 预期的提交范围数组
      • 对意外范围显示警告
      • 如果未设置或为空,则禁用提交范围验证
      • 例如:["ui", "database"]
    • releaseTagGlobPattern 用于过滤发布标签的通配符模式
      • 发布标签必须包含语义化版本号([0-9]+\.[0-9]+\.[0-9]+
      • 默认为 *
    • issueRegexPattern 用于查找问题ID的正则表达式模式
      • 例如:Jira问题模式 [A-Z]{3,}-\\d+
  • changelog
    • commitTypes 按类型过滤提交
      • convention.commitTypes 的子集,加上
        • merge 提交
      • 如果未设置或为空,则禁用提交类型过滤
      • 例如:["feat", "fix", "merge"]
    • commitScopes 按范围过滤提交
      • convention.commitScopes 的子集
      • 如果未设置或为空,则禁用提交范围过滤
      • 例如:["ui"]
    • includeInvalidCommits 包含没有有效类型的提交:默认为 true
      • 如果设置为false,所有未定义 commitTypes 的提交将从更新日志中移除
    • commitIgnoreRegexPattern 通过提交主题正则表达式过滤提交
      • 默认为 ^WIP
    • headlines 标题标识符和实际标题的映射
      • changelog.commitTypes 的子集,加上
        • breakingChange 重大变更部分
      • 例如:{ "feat": "功能", "fix": "错误修复", "breakingChange": "重大变更"}
      • 默认为 { "feat": "功能", "fix": "错误修复", "merge": "合并", "breakingChange": "重大变更"}
    • commitUrl 用于生成指向仓库提交的Markdown链接的URL模板
      • %commit% 提交哈希占位符
      • 例如:https://github.com/qoomon/git-conventional-commits/commit/%commit%
      • 如果未设置或为空,则禁用链接生成
    • issueUrl 用于生成指向问题跟踪器的Markdown链接的URL模板
      • %issue% 问题ID占位符
      • 例如:https://jira.example.org/browse/%issue%
      • 如果未设置或为空,则禁用链接生成

在提交前自动验证提交消息约定

为了自动验证提交消息,可以在 commit-msg 阶段使用git钩子。 可以手动创建钩子,也可以使用 pre-commit 框架

使用 pre-commit 框架设置

  • 在仓库根目录创建 .pre-commit-config.yaml 文件,内容如下:
    repos: - repo: https://github.com/qoomon/git-conventional-commits rev: <RELEASE_TAG> hooks: - id: conventional-commits
  • 安装 pre-commit 框架 pip install pre-commit
  • 安装 commit-msg 钩子 pre-commit install -t commit-msg

手动设置

  • 设置提交消息钩子
    • 导航到您的仓库目录 cd <仓库路径>
    • 创建 git 钩子目录 mkdir .git-hooks
    • 设置更新 hooksPath git config core.hooksPath .git-hooks
    • 创建提交消息钩子脚本并使其可执行
      • touch .git-hooks/commit-msg && chmod +x .git-hooks/commit-msg
      • 用您喜欢的编辑器打开 .git-hooks/commit-msg 并粘贴以下脚本
        #!/bin/sh # 针对 Windows 系统的修复 PATH="/c/Program Files/nodejs:$HOME/AppData/Roaming/npm/:$PATH" npx git-conventional-commits commit-msg-hook "$1"
    • .git-hooks/commit-msg 添加并提交到仓库

[!重要] 每当您克隆带有 git 钩子的仓库时,您需要再次启用 git 钩子 <br>git config core.hooksPath .git-hooks

### 使用 `git-conventional-commits` 的发布工作流程
* 通过 `npx git-conventional-commits version` 确定版本
* 更新项目文件中的版本
  * 提交版本更新 `git commit -am'build(release): 将项目版本升级到 <version>'`
* 通过 `npx git-conventional-commits changelog --release <version> --file 'CHANGELOG.md'` 生成变更日志
  * 提交变更日志 `git commit -am'docs(release): 创建 <version> 变更日志条目'`
* 用版本标记提交 `git tag -a -m'build(release): <version>' '<version-prefix><version>'`
* 推送所有更改 `git push`
* 构建并上传构件

### 与现有仓库集成

如果你有一个没有发布标签(如 v1.0.0)的大型现有仓库,或者你想让第一个变更日志整洁,你需要先创建一个发布标签。
* 为特定提交创建发布标签 `git tag -a -m'build(release): 0.0.0' 'v0.0.0'`
* 推送标签 `git push origin v0.0.0`
这样 `npx git-conventional-commits` 将只考虑发布标签所指向的提交之后的提交。

---
## 使用 git-conventional-commits 的项目
- https://github.com/Blazity/next-enterprise

---

## 构建/发布
* `npm install`
* `npm test`
* `npm login`
* `npm publish`

编辑推荐精选

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
DeepEP

DeepEP

DeepSeek开源的专家并行通信优化框架

DeepEP是一个专为大规模分布式计算设计的通信库,重点解决专家并行模式中的通信瓶颈问题。其核心架构采用分层拓扑感知技术,能够自动识别节点间物理连接关系,优化数据传输路径。通过实现动态路由选择与负载均衡机制,系统在千卡级计算集群中维持稳定的低延迟特性,同时兼容主流深度学习框架的通信接口。

DeepSeek

DeepSeek

全球领先开源大模型,高效智能助手

DeepSeek是一家幻方量化创办的专注于通用人工智能的中国科技公司,主攻大模型研发与应用。DeepSeek-R1是开源的推理模型,擅长处理复杂任务且可免费商用。

问小白

问小白

DeepSeek R1 满血模型上线

问小白是一个基于 DeepSeek R1 模型的智能对话平台,专为用户提供高效、贴心的对话体验。实时在线,支持深度思考和联网搜索。免费不限次数,帮用户写作、创作、分析和规划,各种任务随时完成!

AI主流办公工具有哪些办公热门AI 助手
KnowS

KnowS

AI医学搜索引擎 整合4000万+实时更新的全球医学文献

医学领域专用搜索引擎整合4000万+实时更新的全球医学文献,通过自主研发AI模型实现精准知识检索。系统每日更新指南、中英文文献及会议资料,搜索准确率较传统工具提升80%,同时将大模型幻觉率控制在8%以下。支持临床建议生成、文献深度解析、学术报告制作等全流程科研辅助,典型用户反馈显示每周可节省医疗工作者70%时间。

Windsurf Wave 3

Windsurf Wave 3

Windsurf Editor推出第三次重大更新Wave 3

新增模型上下文协议支持与智能编辑功能。本次更新包含五项核心改进:支持接入MCP协议扩展工具生态,Tab键智能跳转提升编码效率,Turbo模式实现自动化终端操作,图片拖拽功能优化多模态交互,以及面向付费用户的个性化图标定制。系统同步集成DeepSeek、Gemini等新模型,并通过信用点数机制实现差异化的资源调配。

AI IDE
腾讯元宝

腾讯元宝

腾讯自研的混元大模型AI助手

腾讯元宝是腾讯基于自研的混元大模型推出的一款多功能AI应用,旨在通过人工智能技术提升用户在写作、绘画、翻译、编程、搜索、阅读总结等多个领域的工作与生活效率。

AI助手AI对话AI工具腾讯元宝智能体热门 AI 办公助手
Grok3

Grok3

埃隆·马斯克旗下的人工智能公司 xAI 推出的第三代大规模语言模型

Grok3 是由埃隆·马斯克旗下的人工智能公司 xAI 推出的第三代大规模语言模型,常被马斯克称为“地球上最聪明的 AI”。它不仅是在前代产品 Grok 1 和 Grok 2 基础上的一次飞跃,还在多个关键技术上实现了创新突破。

OmniParser

OmniParser

帮助AI理解电脑屏幕 纯视觉GUI元素的自动化解析方案

开源工具通过计算机视觉技术实现图形界面元素的智能识别与结构化处理,支持自动化测试脚本生成和辅助功能开发。项目采用模块化设计,提供API接口与多种输出格式,适用于跨平台应用场景。核心算法优化了元素定位精度,在动态界面和复杂布局场景下保持稳定解析能力。

OmniParser界面解析交互区域检测Github开源项目
流畅阅读

流畅阅读

AI网页翻译插件 双语阅读工具,还原母语级体验

流畅阅读是一款浏览器翻译插件,通过上下文智能分析提升翻译准确性,支持中英双语对照显示。集成多翻译引擎接口,允许用户自定义翻译规则和快捷键配置,操作数据全部存储在本地设备保障隐私安全。兼容Chrome、Edge、Firefox等主流浏览器,基于GPL-3.0开源协议开发,提供持续的功能迭代和社区支持。

AI翻译AI翻译引擎AI翻译工具
下拉加载更多