工程实践
作为构建产物的 changelog:规范、自动化、流水线。
从这里开始: Keep a Changelog 详解,附 CHANGELOG.md 模板、从 conventional commits 到一份体验日志、体验日志自动化:该自动化什么,不该自动化什么
-
什么是热修复?含义、热修复与补丁的区别,以及如何发布
热修复是在正常发布周期之外发布的紧急修复。本文讲这个术语的含义、它与补丁和缺陷修复有何不同,以及如何安全地发布一次热修复。
工程实践阅读约 1 分钟
-
发布候选版本(RC):含义、版本号写法与运作方法
发布候选版本是一个除非测试发现阻塞问题,否则就会作为正式版发布的构建。本文讲它在 beta 之后的位置、版本号写法,以及退出标准。
工程实践阅读约 1 分钟
-
CHANGELOG.md:里面该写什么,怎样保持更新
CHANGELOG.md 是面向读者的记录,说明每个版本改了什么。本文讲它需要哪些分节,给出一份完整示例,以及让它保持更新的那一个习惯。
工程实践阅读约 1 分钟
-
GitHub 发布说明:先自动生成,再改到可读
GitHub 能从已合并的 pull request 一键生成发布说明草稿。本文讲清草稿里有什么、release.yml 如何控制分组,以及把它改得可读的编辑步骤。
工程实践阅读约 1 分钟
-
体验日志文件格式:JSON、YAML,还是干脆用 Markdown
体验日志的文件格式,决定它能否驱动页面和小组件,还是只能被人读一遍。本文讲 Markdown、JSON 和 YAML 各自的代价,以及何时值得迁移到结构化格式。
工程实践阅读约 1 分钟
-
在 GitHub Actions 中要求提交体验日志条目的工作流
这个跑在 GitHub Actions 里的体验日志检查,会在缺少记录时拒绝合并,因为依赖人记得的步骤迟早会失效。本文讲它能验证什么、不能验证什么,以及紧急热修复怎么办。
工程实践阅读约 1 分钟
-
Git 标签、GitHub 发布与体验日志的区别
Git 标签、一次发布和一条体验日志记录,是同一事件的三份记录,用途和读者各不相同。把它们混为一谈,正是体验日志偏离实际发布的原因,本文说明如何对应。
工程实践阅读约 1 分钟
-
Monorepo 的体验日志:到底该合成一份,还是按包拆开
Monorepo 可以为整个仓库维护一份体验日志,也可以每个包各一份,选错会让发布要么太吵,要么信息分散。本文讲如何判断,以及标签、版本号和提交说明怎样配合。
工程实践阅读约 1 分钟
-
语义化版本控制与体验日志:每一种版本跃升的含义
语义化版本控制让调用方在读任何内容之前,就知道这次发布可能带来多大影响。本文说明每个数字承诺了什么,以及一条记录应该交代什么。
工程实践阅读约 1 分钟
-
公开体验日志页面:如何搭建一个人们愿意订阅的页面
体验日志页面只有让人一次次回来看,才值得认真搭建。本文说明它放在哪里、每条记录需要什么内容、信息流和标记语言怎么处理,以及小组件放在哪。
工程实践阅读约 1 分钟
-
体验日志自动化:该自动化什么,不该自动化什么
收集、排版和发布可以交给自动化,唯独挑选和措辞必须由人来完成,没有例外。本文说明这条界线划在哪里,以及界线移动时会带来什么后果。
工程实践阅读约 1 分钟
-
从 conventional commits 到一份体验日志
Conventional commits 能让体验日志内容被自动推导出来,但不会因此自动变得好读。本文说明这个约定带来什么好处、在哪里走到尽头,以及如何弥补两者之间的差距。
工程实践阅读约 1 分钟
-
Keep a Changelog 详解,附 CHANGELOG.md 模板
Keep a Changelog 这份规范只有短短一页,可真正落实时,大多数团队会渐渐偏离。本文说明它写了什么、刻意没回答什么,以及执行时常在哪里出错。
工程实践阅读约 1 分钟