-
体验日志文件格式:JSON、YAML,还是干脆用 Markdown
体验日志的文件格式,决定它能否驱动页面和小组件,还是只能被人读一遍。本文讲 Markdown、JSON 和 YAML 各自的代价,以及何时值得迁移到结构化格式。
工程实践阅读约 1 分钟
-
一个跑在 GitHub Actions 里的体验日志检查
这个跑在 GitHub Actions 里的体验日志检查,会在缺少记录时拒绝合并,因为依赖人记得的步骤迟早会失效。本文讲它能验证什么、不能验证什么,以及紧急热修复怎么办。
工程实践阅读约 1 分钟
-
Git 标签、发布记录和你的体验日志该怎样对应
Git 标签、一次发布和一条体验日志记录,是同一事件的三份记录,用途和读者各不相同。把它们混为一谈,正是体验日志偏离实际发布的原因,本文说明如何对应。
工程实践阅读约 1 分钟
-
Monorepo 的体验日志:到底该合成一份,还是按包拆开
Monorepo 可以为整个仓库维护一份体验日志,也可以每个包各一份,选错会让发布要么太吵,要么信息分散。本文讲如何判断,以及标签、版本号和提交说明怎样配合。
工程实践阅读约 1 分钟
-
如何搭建一个人们真的会持续关注的体验日志页面
体验日志页面只有让人一次次回来看,才值得认真搭建。本文说明它放在哪里、每条记录需要什么内容、信息流和标记语言怎么处理,以及小组件放在哪。
工程实践阅读约 1 分钟
-
从 conventional commits 到一份体验日志
Conventional commits 能让体验日志内容被自动推导出来,但不会因此自动变得好读。本文说明这个约定带来什么好处、在哪里走到尽头,以及如何弥补两者之间的差距。
工程实践阅读约 1 分钟
-
Keep a Changelog,真正落地实践之后的心得
Keep a Changelog 这份规范只有短短一页,可真正落实时,大多数团队会渐渐偏离。本文说明它写了什么、刻意没回答什么,以及执行时常在哪里出错。
工程实践阅读约 1 分钟