编辑JIRA项目的键不是一个简单的任务。当创建项目时,你应该选择一个满足长期需求的键,而不是根据项目创建之后再更改。不过,也有需要更改现有项目键的情况,如更改产品名称。
本页面主要教大家如何更改项目的键,以及描述这种变化所带来的影响。
首先
- 项目键的格式必须是JIRA限制规定的格式。默认情况下,项目键格式必须至少为2个字符,并且只包含大写字母。
你可以更改项目键的格式来实现不同的限制。 - 在低使用率期间执行此更改—当保存更新项目键时JIRA将启动后台重新索引。这可能会对实例的性能产生影响。注意,不能选择 “Lock JIRA and rebuild index”,尽管它会使后台索引变快,但是将受限于项目的问题。
- 将更改传达给用户 – 确保你知道更改项目键的后果,且用户已做好充分准备。
编辑项目键
导航到JIRA项目,并访问项目管理页面。选择Project Administration(项目导航栏的底部)。 选择Edit Project按钮。 选择Key字段旁边的edit key。 更改键并点击Update。
注意:
- 页面上的其它字段,保存后可以直接看到更改后的信息。而不需要等待重新索引完成。
- 不要取消后台重新索引。如果取消,那么搜索与项目有关的问题时将出错。如果需要取消,你可以稍后再取消。
更新任务
- Fix the project entity links?—?当你把JIRA和其它Atlassian应用程序链接时,JIRA项目和其他应用程序相关的项目(如Confluence spaces)之间的实体链接会被自动创建。如果JIRA项目的键更改了,那你需要修改项目的实体链接。
- Updating JIRA Agile board filters?-?如果JIRA敏捷主板使用旧项目键,过滤器板需要更新到新的项目键。否则,版上可能不会显示更名后的项目问题。
变更管理注意事项
编辑项目的键是一个大的更改,多数情况下, 期望JIRA项目以新键运行。注意以下少数情况。
- 旧的项目键可用于JQL查询 – 用户将不必更新引用旧项目键的问题过滤器。
- 如果将Confluence和JIRA一起使用,Confluence中的JIRA问题宏将继续有效。注意,如果你没有马上看到更改,是因为缓存更新需要时间。
- 你不能使用旧的项目键来创建一个新的项目。但你可以将重命名的项目改回旧的项目键。如果删除该项目,所有相关的键将被释放,你就可以重新使用它们。
- 无论是来自JIRA内部或是外部的链接都将正常工作。然而,链接别名不会被更新 – 例如,如果有一个链接到名为“EXAMPLE-1”的链接,将该项目的键“EXAMPLE”改为“DEMO”后,别名\’EXAMPLE-1\’不会更新为\’DEMO-1\’,但该链接还是会链接到DEMO-1。
- 如果你在全局过滤器使用Activity Stream小工具,你需要在项目重命名后更新过滤器。
- 当项目的键更改后所有附件也可访问。但注意,它们的存储目录(dataattachments)将保留旧的项目键。例如,如果把项目的键从TEST改为DEMO后,附件的存储目录仍是dataattachmentsTEST。
- 如果导出一个重命名的项目再将其导入,将显示更新后的项目键,即不会保留原来的项目键。事实上,该项目的所有历史键都将被移除。有一种解决方法,就是直接在你的数据库修改数据。
相关话题
Changing the maximum project key length?—?你可以修改项目键的最大字符长度。导航到JIRA管理控制台的General Configuration页面修改Maximum project key size字段。
Changing the project key format?—?你可以修改项目键的格式,但当创建或编辑项目键时,这将限制其格式。
开发人员注意事项
- 在项目键更改后REST API调用指定关键问题时仍用旧的项目键。例如,项目键从EXAMPLE 改为 DEMO后,/rest/api/issue/EXAMPLE-100仍可用。
- ProjectUpdatedEvent事件被创建,任何时候项目的细节包括项目的键发生改变该事件将被触发。
- 要想检索所有问题键和项目键,你可以通过以下方式:
REST:- 获取所有项目键: /rest/api/2/project/?expand=projectKeys
Java API:
- 获取所有项目键: com.atlassian.jira.project.ProjectManager#getAllProjectKeys
- 获取所有问题键: com.atlassian.jira.issue.IssueManager#getAllIssueKeys
相关产品购买请咨询\”在线客服\”。
本站文章除注明转载外,均为本站原创或翻译
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。