conventional-changelog-recommended-bump v10 自定义预设配置指南
2025-05-28 11:05:13作者:晏闻田Solitary
conventional-changelog-recommended-bump 是一个用于根据 Git 提交历史自动推荐版本号变更的工具。在 v10 版本中,API 发生了重大变化,特别是关于自定义预设的配置方式。本文将详细介绍如何在 v10 版本中正确配置自定义预设。
新旧版本 API 对比
在 v9 版本中,开发者可以直接通过 options 对象传递完整的配置参数,包括自定义模板和解析选项。这种方式虽然直观,但灵活性不足。
v10 版本采用了更模块化的设计,通过 Bumper 类的链式调用提供了更细粒度的控制。主要变化包括:
- 移除了直接的 options 参数
- 引入了 commits()、tag() 和 bump() 方法链
- 将配置分散到各个方法中
v10 版本配置方法
要使用自定义预设,现在需要通过 Bumper 类的实例方法进行配置:
new Bumper()
.commits({
path: '...' // 指定提交路径
}, parserOpts) // 传递解析选项
.tag({
prefix: '...' // 指定标签前缀
})
.bump(whatBump) // 执行版本推荐
关键配置项详解
commits() 方法
commits() 方法接受两个参数:
-
第一个参数是 GetCommitsParams 对象,可以配置:
- path: 指定要分析的提交路径
- from: 起始提交
- to: 结束提交
-
第二个参数是 parserOpts,用于配置提交信息的解析选项,包括:
- headerPattern: 提交头部的正则模式
- breakingHeaderPattern: 破坏性变更的正则模式
- noteKeywords: 注释关键词
- revertPattern: 回退模式
tag() 方法
tag() 方法用于配置版本标签相关选项,可以传递:
- prefix: 标签前缀(适用于 monorepo 场景)
- skipUnstable: 是否跳过不稳定版本
bump() 方法
bump() 方法执行实际的版本推荐计算,可以传递 whatBump 函数来自定义推荐逻辑。
实际应用示例
以下是一个完整的配置示例,展示了如何自定义 breakingHeaderPattern:
const bumper = new Bumper();
const result = bumper
.commits(
{},
{
breakingHeaderPattern: /^(\w*)(?:\((.*)\))?!: (.*)$/ // 自定义破坏性变更模式
}
)
.tag({
prefix: 'pkg-' // 自定义标签前缀
})
.bump((commits) => {
// 自定义版本推荐逻辑
if (commits.some(commit => commit.notes.some(note => note.title === 'BREAKING CHANGE'))) {
return { level: 0 }; // 主版本
}
return { level: 1 }; // 次版本
});
迁移建议
从 v9 迁移到 v10 时,建议:
- 将原来的 options 对象拆解到各个方法中
- 特别注意 parserOpts 现在作为 commits() 的第二个参数传递
- 原来的 lernaPackage 配置可以通过 tag() 方法的 prefix 参数实现
通过这种新的配置方式,v10 版本提供了更灵活、更清晰的 API 设计,虽然迁移需要一些工作,但长期来看更易于维护和扩展。
登录后查看全文
热门项目推荐
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++043Hunyuan3D-Part
腾讯混元3D-Part00GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0286Hunyuan3D-Omni
腾讯混元3D-Omni:3D版ControlNet突破多模态控制,实现高精度3D资产生成00Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp课程中屏幕放大器知识点优化分析2 freeCodeCamp课程视频测验中的Tab键导航问题解析3 freeCodeCamp论坛排行榜项目中的错误日志规范要求4 freeCodeCamp音乐播放器项目中的函数调用问题解析5 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析6 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析7 freeCodeCamp课程页面空白问题的技术分析与解决方案8 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析9 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析10 freeCodeCamp 课程中关于角色与职责描述的语法优化建议
最新内容推荐
PADS元器件位号居中脚本:提升PCB设计效率的自动化利器 QT连接阿里云MySQL数据库完整指南:从环境配置到问题解决 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 全球36个生物多样性热点地区KML矢量图资源详解与应用指南 Windows版Redis 5.0.14下载资源:高效内存数据库的完美Windows解决方案 PANTONE潘通AI色板库:设计师必备的色彩管理利器 OpenSSL 3.3.0资源下载指南:新一代加密库的全面解析与部署教程 ReportMachine.v7.0D5-XE10:Delphi报表生成利器深度解析与实战指南 瀚高迁移工具migration-4.1.4:企业级数据库迁移的智能解决方案 全球GEOJSON地理数据资源下载指南 - 高效获取地理空间数据的完整解决方案
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
161
2.05 K

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
198
279

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
535
62

Ascend Extension for PyTorch
Python
50
81

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
950
556

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1 K
397

本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
385
19

openGauss kernel ~ openGauss is an open source relational database management system
C++
146
191