§ 版本管理系统-使用手册

1. 基础数据
2. 模块管理
- 2.1 业务模块
- 2.2 版本管理
3. 产品管理
- 3.1 业务产品
- 3.2 版本管理
4.申请与审批
5.数据分析

§ 1. 基础数据

§ 1.1 附件类型

该交易主要提供发布模块新版本时的附件类型，主要包含源码、文档、网盘三种。

查询附件

在附件名称查询框内输入附件名称，或者在附件值查询框内输入附件值，点击查询，查询到所匹配的附件信息。（支持模糊查询）
新增附件

点击新增按钮，需要填写必要附件信息，包括：附件类型、附件值、附件名称。

点击提交：保存当前添加的信息，并且返回新的带有上一添加信息的页面。
- 附件类型分为三种：源码、文档、网盘。不同类型的附件值前缀也是不同的，源码的附件值前缀为0，文档的附件值前缀为1，网盘的附件值前缀为2。
- 附件值是唯一的，附件值的后缀需要手动输入，输入的字段长度最大为2。
- 倘若附件值重复的话，会弹出错误提示，并清空输入的附件值。
修改附件

点击需要修改的附件信息当前所在行的修改图标进行修改。

附件类型及附件值不允许修改，只能修改附件名称。

点击提交：保存当前修改的信息，并且返回新的带有上一修改信息的页面。
删除附件

删除附件可以直接点击需要删除的附件信息当前所在行的删除图标进行删除。

*提示：删除附件后，模块、产品引用的附件类型将会丢失，建议轻易不要删除。

§ 1.2 个人凭证

该交易通过GItLab中生成的访问令牌，判断是否可以访问仓库中的工程，在新增业务模块中可以选择添加的令牌。

accessToken会经过混淆之后存储，保证Token值不会被泄露。

添加个人凭证
- 点击新增按钮，输入必填信息，accessToken需要在GitLab中生成。
- 生成accessToken步骤
  - 点击个人信息中的编辑个人资料
  - 选择访问令牌选项
  - 填入Token名称，并勾选令牌权限，点击创建，即可生成access Token。

§ 1.3 分组维护

该交易便于对业务模块进行分类，方便用户检索，针对业务模块的分组信息进行维护。

查询分组

在分组名称查询框内输入分组名称，点击查询，查询到所匹配的分组信息。（支持模糊查询）
新增分组

点击新增按钮：输入分组名称

点击提交：保存当前添加的信息，并且返回新的带有上一添加信息的页面。
编辑分组

点击需要修改的分组信息当前所在行的修改图标进行修改。
删除分组

点击需要删除的分组信息当前所在行的删除图标进行删除。

*提示：删除分组后，模块引用的分组信息将会丢失，建议不要删除。

§ 1.4 项目管理

该交易展示了所有项目信息，针对模块申请和产品申请时进行对项目名称的选择。

查询

在附件名称查询框内输入项目编号、项目名称、项目经理中的一项或多项查询条件，点击查询，查询到所匹配的项目信息。（支持模糊查询）

§ 1.5 操作记录

该交易展示了操作记录信息，当对数据进行增删改操作时，会生成记录。

查询

在附件名称查询框内输入操作人、或选择操作数据类型、或选择操作时间，点击查询，查询到所匹配的操作记录信息。
参数详情

点击当前行的参数信息按钮，可查看当前记录的参数信息。

§ 2. 模块管理

§ 2.1 业务模块

该交易可以实现对模块的增删改操作，以及模块的版本管理、状态设置、权限设置等功能。

查询模块

输入模块简称，或者输入模块名称，或者选择模块类型，点击查询，查询到所匹配的业务模块信息。（支持模糊查询）

模块简称：模块英文名称

模块名称：模块中文名称

模块类型：内置四种类型，分为：微前端、微服务、外壳、工具
新增模块

点击新增按钮，输入必填信息，点击提交，即可新增一个新的业务模块。

Token：可以选择（个人凭证页面）已添加的个人凭证。

git仓库：必须为有效的GitLab仓库地址。

分组信息：可以选择（分组维护页面）已添加的分组信息。

必要文档（附件类型页面中的文档）：该模块必须要上传的文档。
设置状态

点击列表中模块所在行的“设置状态”按钮，可以设置该模块的状态。

模块状态值说明如下：

模块状态值是否可以发布新版本是否可以被引用

有效是是

废弃否否

冻结否是
修改

点击想要修改的模块所在行的编辑按钮，可以实现对模块信息的修改。
删除

点击需要删除的模块当前所在行的删除图标进行删除。

*提示：删除模块后，模块下的版本将一并删除，建议不要轻易删除。

模块状态值	是否可以发布新版本	是否可以被引用
有效	是	是
废弃	否	否
冻结	否	是

§ 2.1.1 版本管理

点击当前行的版本管理按钮，跳转到该模块的版本管理页面。

module_8

在版本管理页面中可以实现发布新的模块版本、设置模块权限等功能。

module_9

模块版本查询：可查询所有模块的版本信息
发布新版本
- 如果该模块未发布过新版本，则当前版本和基线版本为无，发行版本为1.0.0，用户可依据自身情况修改发行版本。
- 如果该模块已经发布了版本，基线版本可从历史版本中选择，默认为当前版本。
- Tag版本对应的是源代码仓库内的标签名。
- Tag版本命名为v+发行版本，并进行Tag版本校验，若源码仓库内不存在该Tag名，则会在提交时自动创建，或者自己手动创建，并进行校验，直到校验通过。
- 制品：因构建物较大，所以请先上传到网盘，并分享为长久有效的私密链接。
- 文档：上传该模块的必要文档（在新建该模块时选择的必要文档）
  
  上传文档时可以选择是否发布，申请该模块时可以看到发布的文档，看不到未发布的文档。
- 最后点击提交按钮，即可创建一个新的模块版本。

§ 2.1.2 设置权限

点击设置权限按钮，可以对该模块进行权限设置，admin为该模块的创建者，默认为联系人（即该模块的审批人，还会收到模块申请的邮件通知）

用户角色分为三种：管理员、操作员、超级管理员。在模块设置中只有管理员和操作员两种角色。

操作	操作员	管理员	超级管理员
审批	√	√	√
设置权限	×	√	√
发行版本	√	√	√
修改	√	√	√
查看全部模块/产品	×	×	√

module_16

版本详情

点击想要查看的版本当前行的详情按钮，跳转至模块版本详情页面。
版本删除

点击想要删除的版本所在行的删除按钮，可以删除该版本。（如果该版本的创建时间超过48小时则不可以删除）

§ 2.2 版本管理

版本管理页面可以从业务模块交易跳转，也可以直接打开，可以查看不同模块下的版本。详情见2.1.1。

module_20

§ 3. 产品管理

§ 3.1 业务产品

该交易可以实现对产品的增删改操作，以及产品的版本管理、状态设置、权限设置等功能。

查询产品

输入产品简称，或者输入产品名称点击查询，查询到所匹配的业务产品信息。（支持模糊查询）

产品简称：产品英文名称

产品名称：产品中文名称
新增产品

点击新增按钮，输入必填信息，点击提交，即可新增一个新的业务产品。
设置状态

点击列表中产品所在行的“设置状态”按钮，可以设置该产品的状态。

产品状态值说明如下：

产品状态值是否可以发布新版本是否可以被引用

有效是是

废弃否否

冻结否是
修改

点击想要修改的产品所在行的编辑按钮，可以实现对产品信息的修改。
删除

点击需要删除的产品当前所在行的删除图标进行删除。

*提示：建议不要轻易删除产品。

产品状态值	是否可以发布新版本	是否可以被引用
有效	是	是
废弃	否	否
冻结	否	是

§ 3.1.1 版本管理

点击当前行的版本管理按钮，跳转到该产品的版本管理页面。在版本管理页面中可以实现发布新的产品版本、设置产品权限等功能。

pro_7

发布新版本
- 如果该产品未发布过新版本，则当前版本和基线版本为无，发行版本为1.0.0，用户可依据自身情况修改发行版本。
- 如果该产品已经发布了版本，基线版本可从历史版本中选择，默认为当前版本。
- 业务模块添加，点击添加按钮，选择要添加的模块
- 产品文档上传
  
  点击上传按钮，上传该产品必传的文档。
  
  上传文档时可以选择是否发布，申请该产品时可以看到发布的文档，看不到未发布的文档。
  - 最后点击提交按钮，即可发布一个新版本的产品。

§ 3.1.2 设置权限

点击设置权限按钮，可以对该模块进行权限设置，admin为该产品的创建者，默认为联系人（该产品的审批人，还会收到产品申请的邮件通知）

用户角色分为三种：管理员、操作员、超级管理员。

操作	操作员	管理员	超级管理员
审批	√	√	√
设置权限	×	√	√
发行版本	√	√	√
修改	√	√	√
查看全部模块/产品	×	×	√

pro_13

产品版本详情

点击想要查看的产品版本所在行的详情按钮，可跳转到产品版本详情页面。

点击文档查看按钮，可以查看该产品下模块的所有文档，可以选择需要下载的文档。

§ 3.2 版本管理

版本管理页面可以从业务产品交易跳转，也可以直接打开，可以查看不同产品下的版本。详情见3.1.1。

pro_17

§ 4.申请与审批

§ 4.1 模块申请

该交易可以申请一个或多个模块，审批通过后，将申请结果以邮件的方式发送。

查询业务模块

在最左侧的业务模块组中的输入框中输入想要申请的模块名称，可以查询到状态为“有效”和“冻结”的模块。

applyM_1

选择模块版本

选择想要申请的模块的版本，附件内容会显示在下方，点击添加按钮，申请列表中会添加刚刚选择的模块。

也可以在当前交易再次添加模块，但是不可以申请重复的模块名称。
点击下一步按钮，填写申请人信息

右侧的申请列表也可以查看申请的模块明细。

点击提交按钮：会弹出提示框，审批通过后，申请结果将以邮件的形式发送。

§ 4.2 产品申请

该交易可以申请一个或多个产品，审批通过后，申请结果将以邮件的方式发送。

查询

在查询框内输入产品名称，点击查询，查询到所匹配的产品信息。

applyP_1

选择申请的产品版本
- 选择想要申请的产品的版本，点击申请按钮，跳转至产品申请信息页面。
- 填写申请人信息，并点击下一步，跳转至产品申请汇总页面。
- 产品申请汇总页面可以查看当前申请的产品信息，申请人信息，模块清单，模块下的附件及该产品的文档。
- 点击提交按钮，弹出提示框，审核通过后，审核结果将以邮件的形式发送。

§ 4.3 我的申请

该交易可查看模块及产品的审批结果。

查询

输入查询条件中的一个或多个条件，点击查询，可查询到匹配的结果。
审批状态

审批状态分为：待审批、已同意、已拒绝、审批中、审批完成。

待审批：申请的产品或模块还未经过管理员审批。

已同意：申请的产品或者模块经过管理员审批通过。

已拒绝：申请的产品或者模块经过管理员审批未通过。

审批中（模块）：按照模块进行申请单拆分，拆分出的子申请单由模块的管理员进行审批，当审批进度不一致时，显示该状态。

审批完成（模块）：按照模块进行申请单拆分，拆分出的子申请单由模块的管理员进行审批，当审批结果中存在已同意和已拒绝时，显示该状态。
查看详情
- 点击想要查看的产品或者模块的当前行的“详情”按钮，可查看产品或者模块的详细内容。
- 产品详情
- 模块详情
  
  子申请单中显示的是申请的业务模块，每个业务模块是分开审批的。

§ 4.4 我的审批

该交易可以对模块及产品进行审批。

查询

输入查询条件中的一个或多个条件，点击查询，可查询到匹配的结果。
审批（产品）

选择审批结果并填写审批理由（必填），点击提交，即可完成对产品的审批。

如果选择同意，审批状态为已同意。如果选择拒绝，审批状态为已拒绝。

在我的申请页面中也可查看到该产品的审批状态。
审批（模块）

如果一次申请了多个模块，模块审批时需要单独审批。
产品申请审批通过后收到的邮件如下：
模块申请审批通过后收到的邮件如下：
- 审批通过
- 审批未通过