Uploaded image for project: 'Jira Cloud'
  1. Jira Cloud
  2. JRACLOUD-67915

The "Editing a project key" documentation page for JIRA Cloud misses the "Notes for change management" and "Notes for developers" sections that are available in the same page for JIRA Server

    XMLWordPrintable

Details

    Description

      Summary

      Almost all the information present in the below documentation page for JIRA Server is missing for JIRA Cloud:


      Specifically the sections named Notes for change management and Notes for developers contain very useful information that should be available to Cloud users as well:

      Notes for change management

      While editing the project key is a major change, in most cases, your JIRA project will work as you'd expect with a new key. There are a few cases that you should be aware of, which are listed below. We recommend reviewing these and advising your users accordingly.

      • The old project key can be used in JQL queries — Users won't have to update issue filters that reference the old project key.
        If you use Confluence with JIRA, the JIRA issue macros in Confluence will continue to work. Please note, if you don't see the change straight away, allow some time for the cache to refresh.
      • You won't be able to create a new project with the old project key. However, you can change the renamed project back to the old project key. If you delete the project, all associated keys will be freed and you'll be able to re-use them.
      • Links will work, whether they are inside JIRA or from external sources. However, link aliases will not be updated — For example, if you have a link to an issue 'EXAMPLE-1' in the description of an issue, and you change the project key 'EXAMPLE' to 'DEMO', then the alias 'EXAMPLE-1' will not be updated to 'DEMO-1'. The link will still direct you to DEMO-1 though.
      • If you are using a gadget with a global filter, you will need to update the filter after the project is renamed.
      • All attachments will be accessible after the project key change. Please note however, that the directory that they are stored in (under the <JIRA Home>\data\attachments directory) will be retain the old project key. For example, if you change a project's key from TEST to DEMO, the attachments will be stored under <JIRA Home>\data\attachments\TEST.
      • If you export a renamed project, then import it, it will have the updated project key, i.e. the original project key will not be retained. In fact, all historical keys for that project will be removed. There is a workaround for this that involves changing data directly in your database, see this Answers post.

      Notes for developers

      • REST API calls will still work with old project key — REST calls that specify an issue key will work with the old issue key after the project key has changed. For example, /rest/api/issue/EXAMPLE-100 will still work after the project key is changed from EXAMPLE to DEMO.
      • We have created a new event, ProjectUpdatedEvent. This event is triggered any time a project's details are changed, including changing the project key.
      • If you need to retrieve all issue keys and project keys (historical and current), you can do this via the following:
        • REST:
          Get all project keys for a project: /rest/api/2/project/<project key>?expand=projectKeys
        • Java API:
          • Get all project keys: com.atlassian.jira.project.ProjectManager#getAllProjectKeys
          • Get all issue keys for an issue: com.atlassian.jira.issue.IssueManager#getAllIssueKeys

      Attachments

        Activity

          People

            skarp Sarah Karp
            dbonotto Dario B
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: