GitLab Issue Bot for Isochronal Heads-up Monitoring
项目描述
关于
此机器人可用于定期在GitLab项目中创建问题。它使用任意一组问题模板和计划配置来创建匹配的问题。
gibihm是在Tecids e.V.开发的，用于GitLab项目中管理基础设施的场景，以及创建定期维护任务的问题/待办事项的需求。
名称
人需要一个工具，可以扔进去带有清单的模板和某种类型的crontab，然后给他！
英文，自由翻译
可以使用一个工具，将带有清单的模板和某种类型的crontab扔进去，然后走人！
使用方法
通用
机器人的配置完全位于机器人将要使用的项目中。要在项目中开始使用机器人，邀请机器人用户加入项目。机器人用户是普通GitLab用户。
如以下所述，将模板和计划配置添加到您的仓库中。您可以在example/目录中找到示例项目。
定义任务
任务定义为问题模板。对于每种需要安排的任务，都需要创建一个模板。理想情况下，模板应包含对任务执行内容的良好描述，包括任务完成的操作项目清单。
任务安排
日程安排是一个YAML文档，位于.gitlab/issue_schedule.yaml或.issue_schedule.yaml。它必须包含一个字典数组，每个字典包含以下键
键 |
描述 |
默认值 |
|---|---|---|
template |
要使用的问题模板的基本文件名（不带.md） |
|
title |
要创建的问题标题 |
|
assignee |
负责人的用户名 |
|
due |
日期表达式（当任务到期时，由dateparser解析 ） |
in one week |
labels |
要分配给创建的问题的标签数组 |
|
confidential |
将创建的问题设置为机密 |
false |
schedule |
定义任务何时安排的类似crontab的日程 |
@weekly |
tag |
用于识别与该任务相关的问题的短标签 |
与template相同 |
配置
通过环境变量配置该机器人。
变量 |
描述 |
默认值 |
|---|---|---|
GIBIHM_API_URL |
GitLab v4 API端点的URL |
CI_API_V4_URL的值 |
GIBIHM_API_TOKEN |
具有api和read_user权限的访问令牌 |
安装
您可以直接从GitLab CI中的Docker镜像使用该机器人，或者将其安装在任何地方并运行
使用pip安装和运行
使用pip从PyPI安装并运行很简单
pip3 install gibihm
export GIBIHM_API_URL=https://gitlab.example.com
export GIBIHM_API_TOKEN=Foo_Bar_Token
gibihm使用Docker安装和运行
该机器人也通过Docker提供
docker pull natureshadow/gibihm
docerk run \
-e GIBIHM_API_URL=https://gitlab.example.com-it \
-e GIBIHM_API_TOKEN=Foo_Bar_Token \
natureshadow/gibihm为单个项目运行
通常，该机器人将在其用户是成员的每个项目中运行。
您可以通过使用--project-id命令行参数传递一个数值项目ID来仅运行一个项目。
从项目CI运行
如果您不想使用全局安装，而是将机器人添加到单个项目中，您可以直接在GitLab CI中配置和运行它。
一个最小的.gitlab-ci.yml如下所示
schedule_issues:
only:
- schedules
image: natureshadow/gibihm
script: [ "true" ]在您的项目设置中，添加GIBIHM_API_TOKEN变量。
然后，您可以使用GitLab的流水线计划定期运行机器人并安排您的问题。
下载文件
下载适合您的平台的文件。如果您不确定选择哪一个，请了解更多关于安装软件包的信息。