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 设计,虽然迁移需要一些工作,但长期来看更易于维护和扩展。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-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).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp音乐播放器项目中的函数调用问题解析2 freeCodeCamp课程页面空白问题的技术分析与解决方案3 freeCodeCamp课程视频测验中的Tab键导航问题解析4 freeCodeCamp课程中屏幕放大器知识点优化分析5 freeCodeCamp全栈开发课程中测验游戏项目的参数顺序问题解析6 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析7 freeCodeCamp 课程中关于角色与职责描述的语法优化建议 8 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析9 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析10 freeCodeCamp Cafe Menu项目中link元素的void特性解析
最新内容推荐
SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 TextAnimator for Unity:打造专业级文字动画效果的终极解决方案 CVE-2024-38077伪代码修复版EXP资源详解:Windows远程桌面授权服务问题利用指南 RadiAnt DICOM Viewer 2021.2:专业医学影像阅片软件的全面指南 CS1237半桥称重解决方案:高精度24位ADC称重模块完全指南 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案 IK分词器elasticsearch-analysis-ik-7.17.16:中文文本分析的最佳解决方案 32位ECC纠错Verilog代码:提升FPGA系统可靠性的关键技术方案 Photoshop作业资源文件下载指南:全面提升设计学习效率的必备素材库
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
239
2.36 K
deepin linux kernel
C
24
6
React Native鸿蒙化仓库
JavaScript
216
291
暂无简介
Dart
539
118
仓颉编译器源码及 cjdb 调试工具。
C++
115
86
仓颉编程语言运行时与标准库。
Cangjie
122
97
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
998
589
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
589
115
Ascend Extension for PyTorch
Python
77
110
仓颉编程语言提供了 stdx 模块,该模块提供了网络、安全等领域的通用能力。
Cangjie
80
55