プロジェクト キーの編集

プロジェクト キーの編集は簡単な作業ではありません。プロジェクトを作成する際は、プロジェクトの作成後にプロジェクト キーを編集する前提で行うのではなく、長期的な要件に合うキーを選択してください。ただし、次のような状況では既存のプロジェクト キーを変更する必要があります。例: 製品名の変更。

このページでは、プロジェクト キーの変更方法と、このような変更の実装について説明します。

はじめる前に

• Your desired project key must conform to the project key format restrictions specified in your JIRA applications. By default, the project key format must be at least 2 characters long and contain only uppercase letters.You can change the project key format to enforce different restrictions. See Changing the project key format for instructions.

• この変更は、使用率が低い時間に実行してください — JIRA アプリケーションは更新したプロジェクトキーを保存すると background re-index を開始します。これにより、インスタンスのパフォーマンスに影響を与える可能性があります。「JIRA をロックしてインデックスを再構築する」を選択することはできません。バックグラウンドインデックスはプロジェクトの課題のみに限定されているため、短時間で実行されます。

• 変更をユーザーに伝える — プロジェクト キーの変更の結果を認識し、ユーザーが変更に十分に備えていることを確認します。詳細は、以下の「変更」セクションを参照してください。

プロジェクト キーの編集

1. > [プロジェクト] を選択し、関連するプロジェクトを選択します。
2. 変更するプロジェクトを見つけます。
3. 変更するプロジェクトの [アクション] 列で [編集] を選択します。
4. プロジェクト キーを編集し、[詳細を保存] をクリックします。インストール済みのアプリケーションのプロジェクト タイプのみを使用できます。

これにより、プロジェクトのインデックス再作成が開始されます。完了時に確認が必要です。

更新後のタスク

• プロジェクトエンティティリンクを修正する — JIRA を別のアトラシアン製品に接続している場合、JIRA プロジェクトと他のアプリケーションの関連「プロジェクト」間でエンティティリンクが自動的に作成されます (例: Confluence spaces)。JIRA プロジェクトのキーを変更すると、「プロジェクト間でリンクを作成する」で説明したように、プロジェクトエンティティリンクを修正する必要があります。
• Updating JIRA Software agile board filters - If your JIRA Software agile boards use the old project key, the board filters may need to be updated to reflect the new project key. Otherwise the board might not display issues from the renamed project.

変更管理の注意事項

プロジェクトキーの編集はメジャーですが、ほとんどの場合、JIRA プロジェクトは新しいキーを使用すると期待通り動作しません。認識しておくべきいくつかのケースを次に示します。これらの内容を確認し、適宜ユーザーにアドバイスすることをお勧めします。

• 古いプロジェクト キーは JQL クエリで使用可能 — ユーザーは、古いプロジェクト キーを参照する課題フィルターを更新する必要はありません。
• Confluence と JIRA を使用している場合、Confluence の JIRA 課題マクロは引き続き動作します。変更をすぐに確認できない場合は、キャッシュが更新されるまでしばらくお待ちください。
• 古いプロジェクト キーを使用して新しいプロジェクトを作成することはできません。ただし、名前を変更したプロジェクトを古いプロジェクト キーに戻すように変更することはできます。プロジェクトを削除すると、関連付られたすべてのキーが解放され、再使用できるようになります。
• リンクは、JIRA 内か外部ソースからどうかに関わらずリンクは作動します。ただし、リンクの別名は更新されません — たとえば、課題の説明で課題「EXAMPLE-1」へのリンクがあり、プロジェクトキー「EXAMPLE」から「DEMO」に変更するお、別名は「EXAMPLE-1」から「DEMO-1」には更新されません。ただし、リンクは引き続き DEMO-1 にダイレクトされます。
• ガジェットをグローバル フィルターとともに使用している場合、プロジェクトの名前を変更した後にフィルターを更新する必要があります。
• All attachments will be accessible after the project key change. Please note, however, that the directory they are stored in (under the <JIRA Home>\data\attachments directory) will 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.

• 名前が変更されたプロジェクトをエクスポートしてからインポートすると、プロジェクト キーが更新されます。元のプロジェクトキーは保持されません。そのプロジェクトのすべての履歴キーが削除されます。これによってデータベース内のデータが直接変更されるのを防ぐ回避策があります。この Answers の投稿を参照してください。

関連トピック

プロジェクト キーの最大の長さを変更する — プロジェクト キーで使用可能な最大文字数を変更できます。「Jira アプリケーションのオプションの構成」に従って Jira 管理コンソールの [一般設定] ページに移動し、[プロジェクト キーの最大サイズ] フィールドを変更します。プロジェクトキーのフォーマットを変更する — プロジェクトキーのフォーマットを変更できます。これにより、作成または編集時にプロジェクトキーのフォーマットを制限します (上記のとおり)。詳細については、「プロジェクトキーのフォーマットの変更」を参照してください。

開発者向けの注意事項

• REST API 呼び出しは古いプロジェクト キーでも動作します。課題キーを指定する REST 呼び出しは、プロジェクト キーの変更後でも古い課題キーで動作します。たとえば、プロジェクト キーを EXAMPLE から DEMO に変更した後でも、/rest/api/issue/EXAMPLE-100 は機能します。
• 新しいイベント、ProjectUpdatedEvent を作成しました。このイベントはプロジェクトの詳細が変更されるたび (プロジェクト キーの変更を含む) にトリガーされます。
• すべての課題キーおよびプロジェクト キー (過去および現在) を取得する必要がある場合は、次の方法で実行できます。
  • REST:
    
    • プロジェクトのすべてのプロジェクト キーを取得: /rest/api/2/project/<project key>?expand=projectKeys
  • Java API:
    • すべてのプロジェクト キーを取得: com.atlassian.jira.project.ProjectManager#getAllProjectKeys
    • 課題のすべての課題キーを取得: com.atlassian.jira.issue.IssueManager#getAllIssueKeys