Dependabot如何识别CHANGELOG文件并在其生成的PR中展示内容?
Dependabot 提取并在PR中展示NuGet包CHANGELOG内容的具体规则
- 文件位置与命名规则
Dependabot仅会识别符合预设命名规范、且存放在包关联公开代码仓库指定位置的变更日志文件:- 文件名优先级从高到低为
CHANGELOG.md>CHANGELOG>CHANGES.md>HISTORY.md>RELEASES.md,大小写不敏感,如changelog.md也可正常识别 - 文件必须存放在仓库根目录,或根目录下的
docs、.github一级子目录中,更深层级目录的文件无法被识别 - 发布NuGet包时,必须在
.nuspec配置中正确填写repository字段,标注包对应的公开代码仓库地址、分支信息,Dependabot依赖该字段定位CHANGELOG文件,仅将CHANGELOG打包进nupkg文件无法触发提取逻辑
- 文件名优先级从高到低为
- 版本匹配规则
只有格式匹配的版本条目才会被提取到PR中:- 每个版本的标题必须符合
[v]主版本号.次版本号.修订号的语义化版本格式,版本前后可附加日期、标签等补充内容,如## v1.2.3 (2024-05-20)、## 2.0.0-beta1均可正常识别 - 条目中的版本号必须与NuGet包发布的版本完全一致,包括预发布后缀,版本号不一致的条目会被忽略
- Dependabot仅提取当前更新跨版本区间内的条目,如从1.1.0升级到1.3.0,仅会提取1.1.0之后、1.3.0及之前的所有版本条目,若对应区间内的版本条目缺失或格式错误,就会出现PR无CHANGELOG展示的情况
- 每个版本的标题必须符合
- 额外限制规则
- 仅公开仓库的NuGet包支持CHANGELOG提取功能,私有仓库包暂不支持
- CHANGELOG文件大小超过1MB时,Dependabot会跳过解析
- 若
dependabot.yml配置中设置了changelog-exclude过滤规则,或changelog-type设为none,会主动关闭变更日志展示功能
内容的提问来源于stack exchange,提问作者Artur Krajewski
相关产品推荐
相关产品推荐

