English | 中文 |
---|
此插件通过收集 Gitlab 的数据来计算以下指标。
指标名称 | 描述 |
---|---|
代码评审次数 | PR/MR创建的数量 |
代码评审通过率 | PR/MR被合并的比率 |
代码评审人数 | 评审PR/MR的人数 |
代码评审时长 | 从PR/MR创建到被合并的时间 |
代码提交人数 | 提交了Commit的人数 |
代码提交次数 | 提交Commit的次数 |
新增代码行数 | 累积新增的代码行数 |
删除代码行数 | 累计删除的代码行数 |
代码评审轮数 | PR/MR创建到被合并期间,经过了多少轮的评审 |
配置界面需要填入以下字段
Connection Name [只读
]
Endpoint URL (REST URL, 以 https://
或http://
开头)
https://gitlab.com/api/v4/
/
结尾Personal Access Token (HTTP Basic Auth)
关于GitLab REST API的更多信息请参考官方文档GitLab Docs on REST
点击Save Connection保存配置。
当前只有一个可选配置,它可以让你将JIRA Boards和GitLab Projects关联起来。
可选
] Map JIRA Boards to GitLab。请以以下格式输入映射规则# 映射JIRA Board ID 8 ==> Gitlab Projects 8967944,8967945 <JIRA_BOARD>:<GITLAB_PROJECT_ID>,...; 例如 8:8967944,8967945;9:8967946,8967947
点击Save Settings保存配置。
你可以向 /pipelines
发起一个POST请求来触发数据收集。
curl --location --request POST 'localhost:8080/pipelines' \ --header 'Content-Type: application/json' \ --data-raw ' { "name": "gitlab 20211126", "tasks": [[{ "plugin": "gitlab", "options": { "projectId": <Your gitlab project id> } }]] } '
要获得一个特定的 Gitlab 仓库的项目ID:
访问 Gitlab 的仓库页面
找到标题下面的项目ID
将此项目ID复制在上方的请求示例中,从这个项目收集数据
登录 Gitlab 后,访问 https://gitlab.com/-/profile/personal_access_tokens
Token 可以设置任意名称,不要设置过期日期。在设置范围时,去掉“写入”权限
点击 Create Personal Access Token 按钮
通过 config-ui 或者 直接将 API Token 复制并保存到 .env
文件中