讲师中心 微信公众号
AI工具推荐 视频效率加速

Python changelog 的自动化生成

轻丽小哥_9816

轻丽小哥_9816

发布时间:2026-02-23 16:51:22

|

512人浏览过

|

来源于php中文网

原创

团队协作选 towncrier,个人项目或已用 Angular 风格规范的选 conventional-commits + cz-cli;towncrier 不依赖 commit 格式,通过 changelog.d/ 碎片文件聚合,避免 rebase 和格式卡点问题。

python changelog 的自动化生成

changelog 生成工具选哪个:towncrier 还是 conventional-commits + cz-cli

直接说结论:团队协作选 towncrier,个人项目或已用 Angular 风格提交规范的,用 conventional-commits + cz-cli 更轻量。

towncrier 的核心优势是「提交时不管格式,发布时才聚合」——它不依赖 commit message 结构,而是靠 PR 合并前手动/自动往 changelog.d/ 下丢碎片文件。这避免了开发者被 feat(api): add timeout 这类格式卡住,也绕开了 rebase 时 commit message 被改乱导致解析失败的问题。

容易踩的坑:

  • towncrier 默认不支持 emoji(比如 ✨ feat),得配 template 或改 pyproject.toml 里的 title_format
  • 如果用 GitHub Actions 自动发布,towncrier 生成 changelog 后必须 git add CHANGELOG.md && git commit,否则下次跑会重复追加
  • conventional-commits 工具链对 commit message 零容忍:少个空行、多一个空格,standard-version 就静默跳过该 commit

towncrier 配置里最常漏掉的三件事

装完 towncrier,光跑 towncrier build 十有八九报错,不是缺配置就是路径不对。

立即学习“Python免费学习笔记(深入)”;

实操建议:

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载
  • 必须在项目根目录放 pyproject.toml,且含 [tool.towncrier] 段;只放 towncrier.toml 会被忽略
  • directory 参数默认是 changelog.d/,但这个目录要手动建好,towncrier 不会自动创建
  • 每个碎片文件名必须带数字前缀和类型后缀,比如 123.feature 或 456.bugfix;用 123.feature.txt 会被跳过

示例片段:

[tool.towncrier]
directory = "changelog.d/"
filename = "CHANGELOG.md"
title_format = "{version} ({project_date})"
template = "changelog.rst"

commit message 不规范时,怎么补救 changelog

历史 commit 没按规范写,又不想重写 history?别硬套 conventional-changelog。

更可行的做法:

  • 用 git log --oneline v1.2.0..HEAD 拿出本轮差异 commit 列表,人工扫一遍,把关键改动对应到 changelog.d/ 下新文件(比如 789.feature)
  • 在 towncrier 配置里设 start_string = "\n<!-- towncrier release notes start -->\n",这样生成时只替换标记之间的内容,旧 changelog 其他部分不动
  • 如果用 GitHub Release,直接把 towncrier build --version 1.3.0 输出粘过去,不走文件写入,彻底避开 Git 冲突

GitHub Actions 里跑 towncrier 的权限和路径陷阱

CI 里 towncrier build 报 FileNotFoundError: changelog.d/ 或权限拒绝,基本是工作流没切对分支或没拉子模块。

关键检查点:

  • 确保 Action 使用 actions/checkout@v4 并开启 fetch-depth: 0,否则 towncrier 找不到 tag
  • 如果 changelog.d/ 是 git submodule,得额外加一步 git submodule update --init
  • 用 towncrier build --yes --version ${{ inputs.version }} 时,$inputs.version 必须是字符串,传 1.3.0 数字会触发 TypeError

真正麻烦的是时间戳:本地 towncrier 用系统时区,CI 默认 UTC,导致生成的 (2024-05-22) 和本地不一致。解决方法是在 workflow 里加 env: TZ: Asia/Shanghai,或者干脆删掉模板里的 {project_date},发布时再手填。

事情说清了就结束

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1638

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2444

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

5924

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

5249

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

6954

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

9714

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

4939

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

5247

2025.08.07

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn