# git-report **Repository Path**: shenliyang/git-report ## Basic Information - **Project Name**: git-report - **Description**: 基于Git提交commit生成的记录查询工具，用于工作日周月报填写 - **Primary Language**: JavaScript - **License**: GPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 108 - **Forks**: 0 - **Created**: 2019-07-01 - **Last Updated**: 2024-04-17 ## Categories & Tags **Categories**: vcs **Tags**: None ## README # 日周月报查询工具 ## 介绍基于 Git 提交项目 Commit Message 生成的日、周、月报查询工具；目前只支持 GitLab 仓库管理系统的查询，后续会不断完善并增加对`码云`和`Github`等平台的支持。开发基于 Electron 构建的跨平台桌面应用，同时支持 windows、Mac OS、Linux 等系统 ## 安装教程 > 选择自己对应的系统平台下载基于 Release [下载地址](https://gitee.com/shenliyang/git-report/releases) 基于热更新 [下载地址 ](https://gitee.com/shenliyang/git-report/tree/master/updater) ## 快速使用 > 简单说只需要以下三步： 1. 到 Gitlab 后台管理，生成私钥(Personal Access Tokens) 2. 下载软件，并按私钥方式登录 3. 根据条件，进行查询和导出 ![](//shenliyang.gitee.io/git-report/img/git-report.gif) ## 配置详细说明 ### Gitlab 配置 1. 登录 Gitlab 后端管理系统 -> [GitLab 登录](https://60.30.5.23/users/sign_in) 2. 点击右侧头像，进入(Setting)用户设置 3. 选择 Access Tokens 选项，进入用户私钥配置 ![](./img/gitlab1.png) 4. 配置用户私钥 1. 输入私钥名称 2. 选择私钥过期时间，或者输入 `Never` 永不过期 3. 选择调用范围，全部勾选 4. 点击按钮，生成私钥 ![](./img/gitlab2.png) 5. 获取私钥复制私钥，请注意保存，该私钥只会出现一次，再次使用只能重新生成，如果不再需要，可以点击`Revoke`按钮销毁私钥。 ![](./img/gitlab3.png) ### 使用说明 1. 打开下载好的软件,进入登录页面复制刚才生产的私钥，粘贴，并点击登录 ![](./img/report1.png) 2. 默认进入项目管理页可以查询本人名下参与的项目 ![](./img/report2.png) 3. 进入日报管理 - 选择查询和导出项目名称(按最近更新时间排序) - 选择查询和导出项目的分支 - 选择需要查询和导出的时间(默认为空) - 是否开启查询本人名下的记录(默认开启) ![](./img/report3.png) 4. 点击查询，对记录进行查询 ![](./img/report4.png) 5. 点击导出，复制内容，粘贴出来 ![](./img/report5.png) ## 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。可以用下方的格式表示它的结构。 ``` (): // 空一行// 空一行