GitLab 集成

GitLab 集成

GitLab 是一个基于云的 DevOps 平台,允许团队规划工作、协作开发代码、构建应用程序和部署应用程序。它提供涵盖整个应用程序开发生命周期的各种工具。GitLab 提供的特性和功能包括版本控制、需求管理、项目管理、自动构建生成、测试和发布管理等。

您可以将 GitLab 与 ServiceDesk Plus Cloud 集成,通过 ServiceDesk Plus Cloud 的变更模块在 GitLab 中实施软件项目。您还可以根据 ServiceDesk Plus Cloud 中的事件请求在 GitLab 中提出问题。

将 GitLab 与 ServiceDesk Plus Cloud集成

GitLab 与 ServiceDesk Plus Cloud 的集成可实现以下功能:

  • 根据变更请求自动在 GitLab 中创建项目

  • 在相应的变更详情页面查看 GitLab 项目

  • 根据事件请求在 GitLab 中创建问题

步骤 1:从 GitLab 获取个人访问令牌

GitLab 使用个人访问令牌来验证 API 调用。

您可以创建任意数量的个人访问令牌。

  1. 在右上角选择您的头像。

  2. 选择编辑个人资料。

  3. 在左侧边栏,选择访问令牌。

  4. 输入令牌的名称和可选有效期。

  5. 选择所需的范围。

  6. 选择创建个人访问令牌。

将个人访问令牌保存在安全的地方。离开页面后,您就不能再访问令牌了。

 


 

步骤 2:使用个人访问令牌创建全局变量

要在自定义脚本中使用从 GitLab 获取的个人访问令牌,必须如下所述创建一个全局变量:

  1. 转到设置 > 开发人员空间 > 全局变量。

  2. 点击新建组。

  3. 提供名称和说明。

  4. 创建以下变量并添加相应的值。

变量

个人访问令牌

粘贴步骤 1 中从 GitLab 复制的个人访问令牌。

  1. 最后,点击保存。


 

注意:此处使用的变量名称应与自定义函数中使用的名称一致。如果使用默认的自定义函数脚本,请使用上表中提到的名称。

步骤 3:构建在 GitLab 中创建项目的功能

要通过 ServiceDesk Plus Cloud 在 GitLab 中自动创建项目,可使用 GitLab API 创建自定义函数,并通过触发器在适当的变更请求中调用该函数。

  1. 转到设置 > 开发人员空间 > 自定义功能。

  2. 点击新建自定义功能。

  3. 为自定义函数提供名称和说明,并将下面的脚本复制到代码编辑器。

  4. 点击保存。


  1. 转到设置 > 开发人员空间 > 自定义模块。

  2. 点击新建。

  3. 在详细信息选项卡下,提供名称及其复数形式。将生成默认的 API 名称。点击保存并转到字段选项卡。

  4. 现在会出现一个名称为 "Change Id "的单行、必填、唯一字段。默认情况下,自定义模块中包含 Gitlab 项目名称字段。

  5. 点击保存。


  1. 转到设置> 自动化> 触发器> 变更触发器。

  2. 点击新建触发器。

  3. 为变更触发器提供一个名称和描述。

  4. 将变更编辑时执行设置为编辑

  5. 将执行时间设置为随时。

  6. 配置自动创建 GitLab 项目的条件。例如,可以为特定的变更模板配置触发器,使其在变更请求进入实施阶段时应用。

  7. 选择为触发操作创建的自定义函数。

  8. 最后点击保存。

当触发器中配置的条件满足时,GitLab 会根据变更请求自动创建一个项目。项目名称将与据以创建项目的变更请求名称相同。


 步骤 4: 构建在变更请求中查看 GitLab 项目的功能

您可以通过使用自定义部件构建功能,在创建 GitLab 项目的相应变更请求中查看该项目。

  1. 下载自定义小部件

  2. 转到设置 > 开发人员空间 > 自定义部件。

  3. 点击新建自定义部件。

  4. 提供名称和描述。

  5. 上传从步骤 1 下载的自定义部件文件(.zip)。

  6. 将托管设置为 Sigma 服务器。

  7. 最后点击保存。



 

根据变更请求自动创建 GitLab 项目时,会在配置的变更阶段添加一个显示项目详细信息的子标签。您可以在设置 > 开发者空间 > 自定义部件下展开部件详情,选择自己喜欢的阶段,自定义标签页显示的阶段。


 

示例:
 


 


 

步骤 5:在 GitLab 项目中建立从事件请求引发问题的功能

通过使用自定义菜单构建功能,您可以使用 ServiceDesk Plus Cloud 提出由变更请求创建的 GitLab 项目中的错误。该功能允许您报告与用于创建 GitLab 项目的变更请求相关联的事件请求中的错误。

  1. G转到设置 > 开发人员空间 > 自定义功能。

  2. 点击新建自定义功能。

  3. 为自定义函数提供名称和说明,并将下面的脚本复制到代码编辑器。

  4. 点击保存。


 

  1. 转到设置 > 开发人员空间 > 自定义菜单 > 请求自定义菜单。

  2. 点击右上角的添加,然后点击新建菜单组。

  3. 为菜单组提供名称和描述,并将状态设为启用。

  4. 点击保存。


 

  1. 点击创建的菜单组名称,然后点击新建菜单项。

  2. 为菜单项提供名称和描述,配置必要的条件和状态,并添加步骤 4 中配置的自定义功能作为动作。

  3. 最后点击保存。

 


 

使用此配置后,在请求详细信息页面的 "自定义动作 "下拉菜单中将提供在 GitLab 项目中提出问题的选项。如果事件请求与绑定到 GitLab 项目的变更请求相关联,则调用此自定义操作将在相应项目中创建问题;在所有其他情况下,都会出错。