Github 创建发行版本
在 Github 上有自己的仓库以后,不断的更新代码和文档,在适合的时候需要发布版本,既 release 。
本文就当前最新版的 Github 怎么设置 release 进行一些说明。
首先打开你的仓库,在界面的右侧找到 Releases
模块,点击进入,之前这个模块是在仓库的上方,和 Issue
在一行。
进来后可以看到你已经发布过的 Release
,如果是新仓库第一次发版的话,这里是空的。
点击右上角的 Draft a new release
会进入 Release
编辑界面。
如下图所示,依次填写相关信息即可。
页面内的信息分别是:
v0.1.0 :版本号,建议用有语义的形式,也有人用日期来作为版本号的。
Target :master :对应的代码仓库的 commit id ,在仓库中是唯一的。
0.1.0 / 2020-07-19 : 这个是 Release Notes 的标题,
[FEATURE] : 这部分内容是 Release Notes 的内容,用来描述你这个版本的变化。
虚线框:这个部分是如果你有编译好的二进制文件或者其他文件,可以通过搜索或者拖拽的方式添加进来。
This is a pre-release:这个标识的意思是这个版本还没有做好在生产环境使用的准备。
上述内容都填好以后,点击 Publish release
就可以发布版本了,选择 Save Draft
可以保存草稿。
发布好的 Release
是这个样子,放置文件的位置,将仓库源代码打了一个 zip 包,一个 tar.gz 包。
当你发布多个版本以后,最后一个没有勾选 This is a pre-release
选项的版本就是你的 Latest release 。
这个版本是一个固定的链接,右键点击页面的 Latest release
选择拷贝链接,就会得到这个固定链接,是 releases/latest
,完整的链接如下:
建议
Release 的版本号和 Release notes 的样式有多种多样,建议大家使用下面一种,
版本号:使用点分三段式的。
示例
第一个数字代表大版本号,第二个数字代表小版本号,第 3 个数字代表该版本的 fix 版本,每个数字都独立依次递增。
如果有 rc 版本或者 beta 版本,格式上可以在正式版本后通过中划线后边加 rc.1 、 beta.1 或者 beta.a 等。
Release notes 的标题,建议 版本号 加日期,中间用斜杠隔开,斜杠左右各留一个空格。日期可以用中划线隔开,也可以连写,没有特别建议,为了美观,可以用中划线隔开。
示例
Release notes 建议分类别,一条一条的列出来,文字简短凝练,后边可以加上 Issue 编号,方便追溯查看。
示例,比如 Prometheus 的 Release notes
可以供选择的类别有,当然,也可以根据自己的实际情况增加类别。
CHANGE
FEATURE
ENHANCEMENT
BUGFIX
最后,记得经常更新代码仓库。
版权声明: 本文为 InfoQ 作者【耳东】的原创文章。
原文链接:【http://xie.infoq.cn/article/bd95993aeffb68f9b37af8d85】。未经作者许可,禁止转载。
评论