首页 南图游戏下载 正文

不再有秘密更新日志

我们以前的更新日志,那真是糊涂账

我跟你们讲,搞软件这行,最怕的就是稀里糊涂地部署了东西,然后一堆人问:“这回到底改了”以前我们公司,别看业务跑得挺欢,但更新日志这块,简直就是一团浆糊。我决定要搞定这个《不再有秘密更新日志》的项目,纯粹是被逼无奈,被那些扯皮的事情折腾得受不了。

本站为89游戏官网游戏攻略分站,89游戏每日更新热门游戏,下载请前往主站地址:www.gm89.me

以前的版本控制和发布流程,用一个字形容,那就是“靠喊”。代码倒是规规矩矩地用着Git,大家也往上推,但提交信息(Commit Message)那真是五花八门。有人写“修了个小bug”,有人写“今天心情优化了一下”,甚至还有人写“别问,问就是改了”,简直是让人火大。

一旦遇到问题,比如客户大晚上打电话来,说新上线的某个功能崩溃了,我们得花两个小时去翻代码记录,再花一个小时去问当时负责的同事到底动了哪里。那个同事要是正好在睡觉,你就只能干瞪眼。更要命的是,每次发布版本给运营部门,运营总得自己手动整理一个“更新说明”,他们就跑到我们工位上,一个一个问:“哥们儿,你上周那个代码,具体修了什么?”我们还得重新回忆,费时费力,效率极低。

我当时真是受够了。我说,这么搞下去,我们早晚得出大事,迟早会因为一个没有记录的更新,导致整个系统瘫痪。

从规范提交开始——逼着大家写“人话”

要解决这个问题,就得从根儿上抓起。我知道市面上有很多专业的工具能干这个事,但那些工具部署起来麻烦,而且收费。我们这种小团队,就得用土办法,而且得是能让大家立马接受的办法。

我坐下来,仔细琢磨了一下午,更新日志的核心来源是什么?不就是那堆提交记录吗?既然记录本身乱七八糟,那就得先规范它。我召集了所有开发,强行规定了一个提交备注的格式,虽然没有用什么高大上的名字,但我把它分成了三类:

  • [Feat]:新加的功能。
  • [Fix]:修复的错误。
  • [Chore]:杂七杂八的优化或配置修改。

我跟他们说:“你们别跟我讲什么专业术语,就按这三条给我写,写清楚改了什么。如果不按格式写,代码我就不让合进去,直接驳回。”

一开始大家都抱怨,说我事儿多,但慢慢地,他们发现这么做帮了他们自己。因为当他们需要回溯历史的时候,直接搜索`[Fix]`,就能快速找到上次修了哪些bug,不用在几百条提交记录里大海捞针。

写脚本,跑起来,让日志自动长出来

规范了输入,下一步就是自动化输出了。我的想法很简单:既然所有的信息都规范地躺在Git仓库里了,我只要写个简单的程序,让它自动抓取这些信息,然后格式化成我们需要的更新日志不就行了?

我当时用了一个非常简单的Python脚本(代码写得有点粗糙,能跑就行)。

这个脚本主要做了三件事:

  1. 抓住范围:它会对比上一个发布版本的标签(Tag)和当前提交的代码,找出这期间所有的提交记录。
  2. 拆分归类:脚本会根据我强制规定的那些前缀,比如`[Feat]`、`[Fix]`,把所有提交记录进行分组。
  3. 生成文档:它会把这些分组好的信息,自动排版成一份干净整洁的Markdown格式文档,并且在头部加上版本号和发布时间。

这个脚本,我直接把它塞进了我们的部署流程里。意思就是,只要我们一打Tag准备发布,这个脚本就自动跑一遍,生成最新的日志文件。这个日志文件生成后,我们会把它自动推送到一个专门的展示页面,同时也会打包进项目交付给运营。

这么一来,以前那个要人工整理两小时的更新说明,现在只需要不到五秒钟,而且准确率是百分之百。

不再有秘密更新日志,救了我一命

你们可能会觉得这只是小事一桩,搞得这么复杂干但我告诉你们,这个系统救了我一命。

就在我推行这个自动化日志系统没多久,我们接了一个非常重要的客户项目,合同金额巨大。上线前夕,客户突然提出,他们认为某个非常关键的权限功能没有到位。当时负责部署的同事吓坏了,说:“肯定到位了,上周我就提交了!”

以前要是遇到这事儿,我们肯定得手忙脚乱地翻代码、截图、找邮件,结果客户那边已经急得跳脚了。

但这回不一样了。我直接打开我们自动生成的“不再有秘密更新日志”页面,输入版本号。在日志的`[Feat]`部分,清清楚楚地写着:“V1.3.4版本,新增了高级用户访问控制权限。”而且因为提交备注写得够详细,连具体的改动点都列出来了。

我直接把这个页面截图发给了客户代表,并解释了这是我们系统自动生成的,不可篡改的发布记录。客户一看,记录详细,逻辑清晰,立刻相信了我们,只是他们自己内部沟通出了问题,没把这个功能加进测试范围。

这一下,不仅省去了我们大量的解释和扯皮时间,更重要的是,我在客户面前展现了我们团队的专业和严谨。从那以后,不管是内部沟通还是外部交付,我们都把这份“不再有秘密更新日志”当作了唯一标准。现在想想,要是没有当初被那些糊涂账气得发疯,我可能还不会动手去搞这个自动化。实践证明,很多时候,越是觉得麻烦的小事,越值得我们花时间去彻底自动化、透明化。一切尽在掌握,真是舒服多了。

小编温馨提醒:本站只提供游戏介绍,下载游戏推荐89游戏,89游戏提供真人恋爱/绅士游戏/3A单机游戏大全,点我立即前往》》》绅士游戏下载专区

相关推荐