背景
最近在做一个项目,代码都已经托管到github上,准备走开源路线。 项目: 一个重大轮子: 基于mysql数据库binlog的增量订阅&消费
使用了github的issue tracker代码,本文记录一下如何使用github管理release notes,希望能给大家玩github的有所帮助。
过程
步骤1 (准备issue/milestone素材)
首先,需要先学会github issue/milestone的使用. 要做release notes,也得有最基本的issue素材。
github issue基本介绍:https://github.com/blog/831-issues-2-0-the-next-generation
1. 创建milestone
2. 创建issue(选择一个milestone)
这样基本上release相关的素材就已经准备完毕了.
步骤2 (准备github pages)
What are GitHub Pages? GitHub Pages are public webpages freely hosted and easily published through our site. You can publish online using the Automatic Page Generator. If you prefer to work locally you can use the GitHub for Mac and Windows apps, or the command line.
github pages介绍:
创建pages,我选择比较简单的,基于github automic generator,文档: https://help.github.com/articles/creating-pages-with-the-automatic-generator
进入自己工程的settings页面,点击Automatic Page Generator按钮,按照提示一步步下去即可,最后点击Publish,即发布完成.
自动生成后的链接地址为: username.github.com/reponame or orgname.github.com/reponame
步骤3 (准备release notes生成脚本)
1 下载之前生成的Git Pages,选择gh-pages分支
git clone git@github.com:xxxx.git -b gh-pages
2. 下载开源的releasenotes plugin:
git clone https://github.com/posabsolute/releasenotes.git
3. 合并
cp -R releasenotes/css releasenotes/js releasenotes/images gh-pages/ cp releasenotes/index.html gh-pages/release.html
4. 修改release.html相关参数
$(document).ready(function() { $("#releaseNotesContainer").releaseNotes({ milestonesShown : 10, // If you want to show private repo // You need to add repo credentials in api.php phpApi : false, phpApiPath : '/', showDescription : true, showComments : true, // Used if phpAPI is false repo : 'canal', //改成己的repo name username : 'otter-projects' //改成自己的username或者orgname }); });
5. 收工,ci & push代码
releasenotes plugins的基本原理
- 利用api.github.com提供的restful接口,相关api说明: http://developer.github.com/v3/issues/
事例: https://api.github.com/repos/otter-projects/canal/milestones
最后
验收结果,比如我的工程: http://otter-projects.github.com/canal/release.html
效果图:
相关推荐
:memo: 发行说明生成器一个基于项目卡的GitHub发行说明生成器。入门安装我们假设您已经安装了node v12.20.1或更高版本。 要安装rng,只需运行: npm i -g rng-cli或者,如果您喜欢: yarn global add rng-cli用法...
blueprint-docify, 用于Github页面访问的自动生成API蓝图文档 蓝图 docify自动生成可以测试和漂亮的API文档 ;DR在的root 中添加你的API规范作为 api.apib,然后推 ! 它将为每个拥有API蓝图( .apib )的分支生成好的...
使用GitHub API基于SwiftUI MVVM和Combine框架构建的iOS示例项目
该工具为GitHub存储库生成发行说明,其中包括自上一发行以来合并的PR和已解决的问题的摘要。 使用release标签参数,它将为现有发行版生成发行说明,以便您可以为以前的发行版回填此信息。 例子: ./gen_release_...
Release:一个命令行工具,能够自动管理 GitHub 上的发布版本
内容概要:通过带着读者设计并实现了一个基于 Github 的 Java 程序缺陷修复原型系统 VulRepair。并且为了验证 VulRepair 的缺陷修复效果,还设计并实现了一组评估对比实验,从多个角度评估验证本文提出的缺陷修复...
GitHub支持的Milestone东西_JavaScript_SCSS_下载.zip
Github Markdown或Bear Notes的自动生成的目录 由脚本生成;) 目录 总览 我喜欢用进行各种笔记。 最近,贝尔发布了一项功能,该功能允许标头与。 因此,我创建了一个脚本,用于基于标题为笔记自动生成目录。 安装 ...
自动构建工具使用 安装包命令:go get github.com/whr-helen/go-struct-auto 注释:参数信息 -host host改为自己数据库的地址(默认127.0.0.1) -port port改为自己数据库的端口(默认3306) -acc acc改为自己...
利用GitHub上喜欢(star)的项目生成类 awesome 列表的汇总页面。便于归档、和记录star变更
GitHub 开源的超简单头像生成器,网友:好Q啊
在Github Pages上线简历生成和部署
基于Selenium爬虫的自动每天点绿github主页的python脚本
GitHub Repository卡片生成器
为基于github标签,已解决问题和PR的发行版生成发行说明 安装 作为.NET工具分发,因此请使用以下内容进行安装 dotnet tool install release-notes 跑步 dotnet release-notes 如果将其安装为全局工具,则可以省略...
生成有关GitHub里程碑当前状态的报告 跑步 当前这是一个终端应用程序。 要安装依赖项: npm install 要运行它,只需使用: node index.js > output.html 然后在浏览器中打开生成HTML,例如, open output.html 。...
GitHub现在 现在,您的GitHub个人资料页面。 GitHub现在允许您动态更新GitHub个人资料。 您要显示当前正在播放的Spotify歌曲吗? 您是否要显示下一次会议演讲演出的... 要预览您的个人资料在GitHub上的外观,只需访
基于电动汽车用PMSM永磁同步电机MTPA_MTPV算法生成idiq表,文件内包含说明文档、生成id iq查询表所用的m程序、以及电机参数输入gui界面
GitHub Release是一个命令行实用程序,用于将文件上传到GitHub版本。 一旦掌握了它,就可以像这样运行它: github-release upload \ --token ' ... ' \ --owner ' someone ' \ --repo ' something ' \ --tag '...