Redmine issue import plugin 用户手册

Redmine issue import plugin 用户手册

作者:北京群英汇信息技术有限公司
网址:http://www.ossxp.com/
版本:1:0.3.1-4
日期:2010-07-28 16:42:10
版权信息:Creative Commons

目录

1   说明

2   功能介绍

在使用redmine的过程中可能会遇到以下两种情况:

  1. 有一些问题是固定的,多个项目中都需要用到这些问题,新建一个项目后,都需要手动添加这些固定问题,即繁琐又浪费时间。
  2. 大型项目异地开发可能需要将总部redmine中的一些问题导出,然后导入到异地团队使用的redmine中(这两个redmine没有部署在同一台服务器上)。

对于第一个问题,如果你的redmine是0.9以后的版本,可以通过 项目复制 功能,将原项目的问题复制到新项目中去。但这个复制是将原项目的所有问题都复制到新项目中,显然那些非固定问题也被复制了,这就需要额外手动删除这些非固定问题,大量时间浪费在删除操作上。

redmine-issue-import插件可以完美地解决上面的问题,它可以将redmine系统导出的问题(csv格式),直接导入到新的项目中。

3   使用方法

3.1   开启问题导入功能

  1. 以redmine系统管理员身份登录redmine,点击 管理 -> 配置 -> 角色和权限 ,为适当的用户添加问题导入权限。

    images/setting1.png
  2. 选择待导入问题的项目,点击 配置菜单 ,选择 问题导入工具 复选框,点击保存,你会发现该项目多了一个 问题导入 菜单。

    images/setting2.png
    images/setting3.png

3.2   编辑csv文件

最简单也最省时的方法就是直接从redmine导出那些需要导入的问题(注意选择csv格式导出),可以省去手动编写csv文件的过程。

当然,你也可以手动创建csv文件,但要注意csv文件中要包含标题行。

导出示例:

为了能够正确导入问题的 指派给作者 字段,需要在导出前调整用户的显示格式。

操作步骤:

以管理员身份登录redmine,点击 管理 -> 配置 -> 显示 ,将 用户显示格式 字段更改为 登录名 的显示方式。

images/export1.png

然后选择待导出问题的项目,点击 问题 菜单,筛选要导出的问题(注:可以借助问题过滤器功能,筛选将要导出的问题),然后点击右下角的 CSV 链接,以CSV格式导出。

images/export2.png

在导出结束后,你可以重返管理界面,将 用户显示格式 恢复为原来的显示格式。

Note

为了避免出现中文乱码,你需要转换导出的export.csv文件的编码格式为UTF-8。

  • Linux 用户可使用iconv命令: iconv -f gbk -t utf8 export.csv > issues.csv
  • Windows 用户可以用notepad打开,然后选择 文件 -> 另存为... ,在编码方式下拉框中选择UTF-8。

3.3   导入操作步骤

3.3.1   上传csv文件

以具有问题导入权限的用户登录系统,选择待导入的项目,点击 问题导入 菜单,进入问题导入界面。

选择本地的csv文件,编码方式保持默认值: UTF8 ,字段分隔符也保持默认值: , ,文本字段包裹符也保持默认值: " ,然后点击 上传文件 按钮。

images/import1.png

3.3.2   字段匹配

选择csv文件中每一列对应的redmine问题数据表中的字段。对于那些不需要导入的字段,可以选择 忽略 选项。

匹配结果如下图

images/import2.png

说明:

  • 选择对应的字段

    • 下拉框左侧标签是csv文件中的标题行,而下拉框中的内容则对应于redmine中的问题字段。
    • 如果你是使用redmine导出的csv文件,那么可以将 #、项目、更新于、创建于这四个字段置为 忽略 。这也意味着,如果你是自己创建csv文件,那么标题行无须这四个字段。
    • 如果你需要导入目标版本字段,那么需要注意目标版本的使用范围,因为有的目标版本不共享,只允许原项目使用,如果这事你选择目标版本,会导致导入失败。因此建议你最好不要导入目标版本字段,将该字段置为 忽略
  • 导入规则

    • 默认跟踪

      如果你在字段配对中选择了跟踪,即没有将该字段置为 忽略 ,那么被导入的问题跟踪字段的值由csv文件中对应的值决定。否则由该默认值决定。

    • 更新已存在的问题

      如果选中该复选框,以下几个灰色状态的选项将消失,变成可用字段。建议最好不要开启此功能,否则导入操作将会变得复杂,还有可能将一些本来不需要更新的已存在的问题覆盖掉。

      • 选择用于标识问题的唯一字段

        一般情况下选择 #

        如果你选择其他字段,可能会导致将一些本来不需要更新的问题覆盖掉。(仅仅是因为某一字段与被更新的问题的字段相同。)

      • 选择问题变更日志字段

        选择哪个字段作为问题变更日志列表的内容

      • 允许更新其他项目的问题

        强烈建议不要开启。

        如果选中,当根据查询条件找到的已存在问题是其他项目的问题,也会自动更新。

      • 忽略不存在的问题

        如果选中,那些作为更新条件查询结果为空的情况会自动跳过。

3.3.3   提交

点击 提交 按钮,完成问题导入。页面跳转到导入结果页面:显示一共导入多少个问题,以及成功导入多少个问题。

images/import3.png

导入情况汇总

images/import4.png

导入的问题列表