在本教程中,我们将使用的最重要的特性是Gitlab Service Desk。Service Desk是Gitlab Premium v9.1中发布的一个功能。它旨在简化开发团队和客户之间的交互。引用官方发布中的公告,
你的客户或任何与项目中人员有联系的人都可以将bug、特性请求或任何其他一般反馈直接发送到你的GitLab项目中。反过来,任何GitLab用户都可以直接从项目中进行响应。
我们可以充分利用这个特性,并使用它通过电子邮件将支持票(support ticket)直接发送到我们的新存储库中。
要启用Service Desk,你只需转到存储库的常规设置并向下滚动到Service Desk,。点击Expand (展开)并启用它(默认情况下它可能已经启用了)。你将看到Gitlab自动为要发送的支持请求生成了一个电子邮件地址。
现在一切都设置好了,我们可以开始编写我们自己的票证系统脚本了!
一个用Python编写的票证系统
我们将使用Gitlab REST API(点击这里查看文档https://docs.gitlab.com/ee/api/ )与我们的票证系统存储库以及Python requests库进行交互。要安装这个库,你只需按照官方的安装说明即可。下面的步骤都是用Python 3.7.3和requests 2.22.0进行测试的。
让我们创建一个Python脚本,并将其命名为gitlab-ticket.py。首先要做的是导入 requests库的内容。
大多数API功能都需要某种形式的身份验证。你可以使用OAUTH令牌,也可以使用个人访问令牌。我选择了后者。Gitlab文档中提供了创建个人访问令牌的说明。
Gitlab API请求的一般形式如下:
你可以在你的项目存储库的主页上获取项目ID。
为了使代码更具可读性,让我们在Python脚本中添加以下几行代码:
确保分别用你的个人访问令牌和项目的ID替换privateToken和projectId。
为了测试我们的设置,我们来将以下内容添加
到脚本中。这段代码会尝试从Gitlab检索项目属性并以JSON格式打印它们。你可以通过简单地执行来运行这个脚本:
你应该会看到一串JSON打印到屏幕上。如果没有,请确保你的个人访问令牌和项目ID是正确的。你现在可以安全地删除我们添加到Python脚本中的最后一行了。接下来,我们将为我们的票证系统设计一些功能。
设计一些功能
此时,一切都如预期的那样开始运行,你应该能够使用Gitlab API向你的存储库发出请求。我们准备开始编写我们的票证系统脚本了。
为了简单起见,我们将只在票务系统中加入几个功能。支持票将在存储库的问题中进行管理,并根据我们将要定义的类别进行标记。标签的分配应该是自动化的,并将基于一个常见的问题标题前缀。脚本应该负责添加缺失的标签。
实现
现在我们已经知道了我们的目标是什么,让我们深入研究代码。
首先,我们定义一些票的类别。我们将使用一个Python字典来保存数据。我们添加两个类别,将其命名为Hardware 和Gitlab Account ,前者用于与硬件相关的东西,后者用于Gitlab帐户创建请求。
每个类别都有一个唯一的标识符,以及一个关联的标签(带有名称和颜色)。
接下来,我们必须将这些标签添加到存储库中。为此,我们使用Gitlab API提供的labels请求。如果没有发生错误,请求将返回状态码201。如果一个标签已经存在,我们只需忽略错误并继续执行。
然后,我们从存储库中检索所有问题的列表。这将允许我们对它们进行迭代,并根据每个问题的标题自动为其分配正确的标签。
如果存储库中只有一个问题,resp.json() 将会返回一个字典,而如果有多个问题的化,它将会返回一个字典列表。我们来将其标准化,并始终使用一个列表。
接下来,我们遍历所有的问题并搜索Service Desk发布的问题。然后检查是否存在预定义的标题头部。一个典型的服务票标题如下所示:
我们试图找到与方括号内的类别ID之一对应的这个标题的子字符串,并将相应的标签附加给它。
就是这样!我们现在已经将一个简单的票务系统完全集成到Gitlab了。当你每次运行这个脚本时,所有问题都将自动使用正确的标签进行更新。我们来测试一下。
进行测试
我们来向Gitlab为我们的存储库生成的地址写一封电子邮件。我将请求一个新的屏幕:
做了那么多年开发,自学了很多门编程语言,我很明白学习资源对于学一门新语言的重要性,这些年也收藏了不少的Python干货,对我来说这些东西确实已经用不到了,但对于准备自学Python的人来说,或许它就是一个宝藏,可以给你省去很多的时间和精力。
别在网上瞎学了,我最近也做了一些资源的更新,只要你是我的粉丝,这期福利你都可拿走。
我先来介绍一下这些东西怎么用,文末抱走。
(1)Python所有方向的学习路线(新版)
这是我花了几天的时间去把Python所有方向的技术点做的整理,形成各个领域的知识点汇总,它的用处就在于,你可以按照上面的知识点去找对应的学习资源,保证自己学得较为全面。
最近我才对这些路线做了一下新的更新,知识体系更全面了。
(2)Python学习视频
包含了Python入门、爬虫、数据分析和web开发的学习视频,总共100多个,虽然没有那么全面,但是对于入门来说是没问题的,学完这些之后,你可以按照我上面的学习路线去网上找其他的知识资源进行进阶。
(3)100多个练手项目
我们在看视频学习的时候,不能光动眼动脑不动手,比较科学的学习方法是在理解之后运用它们,这时候练手项目就很适合了,只是里面的项目比较多,水平也是参差不齐,大家可以挑自己能做的项目去练练。
(4)200多本电子书
这些年我也收藏了很多电子书,大概200多本,有时候带实体书不方便的话,我就会去打开电子书看看,书籍可不一定比视频教程差,尤其是权威的技术书籍。
基本上主流的和经典的都有,这里我就不放图了,版权问题,个人看看是没有问题的。
(5)Python知识点汇总
知识点汇总有点像学习路线,但与学习路线不同的点就在于,知识点汇总更为细致,里面包含了对具体知识点的简单说明,而我们的学习路线则更为抽象和简单,只是为了方便大家只是某个领域你应该学习哪些技术栈。
(6)其他资料
还有其他的一些东西,比如说我自己出的Python入门图文类教程,没有电脑的时候用手机也可以学习知识,学会了理论之后再去敲代码实践验证,还有Python中文版的库资料、MySQL和HTML标签大全等等,这些都是可以送给粉丝们的东西。
这些都不是什么非常值钱的东西,但对于没有资源或者资源不是很好的学习者来说确实很不错,你要是用得到的话都可以直接抱走,关注过我的人都知道,这些都是可以拿到的。
版的库资料、MySQL和HTML标签大全等等,这些都是可以送给粉丝们的东西。
这些都不是什么非常值钱的东西,但对于没有资源或者资源不是很好的学习者来说确实很不错,你要是用得到的话都可以直接抱走,关注过我的人都知道,这些都是可以拿到的。