日周月报查询工具
介绍
基于 Git 提交项目 Commit Message 生成的日、周、月报查询工具;目前只支持 GitLab 仓库管理系统的查询,后续会不断完善并增加对码云和Github等平台的支持。
开发基于 Electron 构建的跨平台桌面应用,同时支持 windows、Mac OS、Linux 等系统
安装教程
选择自己对应的系统平台下载
基于 Release 下载地址
基于热更新 下载地址
快速使用
简单说只需要以下三步:
到 Gitlab 后台管理,生成私钥(Personal Access Tokens)
下载软件,并按私钥方式登录
根据条件,进行查询和导出
配置详细说明
Gitlab 配置
登录 Gitlab 后端管理系统 -> GitLab 登录
点击右侧头像,进入(Setting)用户设置
选择 Access Tokens 选项,进入用户私钥配置
配置用户私钥
输入私钥名称
选择私钥过期时间,或者输入 Never 永不过期
选择调用范围,全部勾选
点击按钮,生成私钥
获取私钥
复制私钥,请注意保存,该私钥只会出现一次,再次使用只能重新生成,如果不再需要,可以点击Revoke按钮销毁私钥。
使用说明
打开下载好的软件,进入登录页面
复制刚才生产的私钥,粘贴,并点击登录
默认进入项目管理页
可以查询本人名下参与的项目
进入日报管理
选择查询和导出项目名称(按最近更新时间排序)
选择查询和导出项目的分支
选择需要查询和导出的时间(默认为空)
是否开启查询本人名下的记录(默认开启)
点击查询,对记录进行查询
点击导出,复制内容,粘贴出来
Git Commit message 编写指南
以下仅为代码提交规范,可以更合理生成日报记录,好的规范,也是好的习惯。
介绍
在 Git 中,每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。这个操作将通过 git commit 完成。
git commit -m "hello world"
上面代码的-m 参数,就是用来指定 commit mesage 的。
如果一行不够,可以只执行 git commit,就会跳出文本编译器,让你写多行。
git commit
格式
Commit message 包括三个部分:Header,Body 和 Footer。可以用下方的格式表示它的结构。
(): // 空一行// 空一行
其中,Header 是必需的,Body 和 Footer 可以省略(默认忽略),一般我们在 git commit 提交时指定的 -m 参数,就相当于默认指定 Header。
不管是哪一个部分,任何一行都不得超过 72 个字符(或 100 个字符)。这是为了避免自动换行影响美观。
heade
Header 部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)。
type
feat:新功能(feature)
fix:修补 bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动
感谢
感谢码云提供的开源项目平台和支持