プロジェクトキーの形式の変更

プロジェクト キーの編集

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Jira はシステム内で、プロジェクトキーの書式を指定する機能を提供します。これによりプロジェクトキーが作成または編集された時のプロジェクトキーの書式を制限できます。

プロジェクト キーの形式は、有効なプロジェクト キーの形式を管理する正規表現のルールで定義されます。既定では、Jira プロジェクト キー構成では、正規表現 ([A-Z][A-Z]+) に基づき、2 文字以上の大文字のアルファベットを使用する必要があります。

On this page:

はじめる前に

  • サポートされているプロジェクトキー形式を選択したことを確認します。次のルールをすべて満たす書式のみがサポートされます:
    • 最初の文字はアルファベットにする必要があり、
    • プロジェクトキーに使用するすべての文字はモダン ローマン体の大文字を使用し、
    • 文字、数字、アンダースコア記号のみを使用できます。
      例:
      • サポートされるキーの例: PRODUCT_2013R2D2MY_EXAMPLE_PROJECT。  
      • サポートされないキーの例: 2013PROJECT  (最初の文字がアルファベットでない)PRODUCT-2012  (ハイフンはサポートされません)
  • Jira はこのキーが特定のルールを順守することを期待しているため、課題キーのパターンを設定することはできません。既定では、JIRA 課題キー (または課題 ID) の形式は<project key>-<issue number> です。例: ABC-123。 たとえば、プロジェクトキーの前に課題番号を示すことはできません。
  • Jira インストールで既に多数の課題が作成されている場合、プロジェクトキーの形式を変更することはお勧めしません。課題を既に作成した後でプロジェクトキーのパターンを変更する必要がある場合は、現在のものよりもさらに「許容可能な」プロジェクトキーのパターンが可能な正規表現を使用します (例: Jira インストールで定義された既存のプロジェクトキーでまだ有効な正規表現を使用する)。

Jira を Bamboo と統合した場合、Jira の既定のプロジェクトキーの書式を変更しないでください。Bamboo でサポートされるのはこのキー形式のみです。

プロジェクトキーの形式の設定

jira.projectkey.pattern プロパティでは、管理者は有効なプロジェクト キーのルールを定義する Perl5 の正規表現を指定できます。Perl5 の詳細については、こちらを参照してください。

このプロパティおよび正規表現値は、「詳細設定」ページで定義できます。これについては、以下で説明します。

手順 1.プロジェクトキー構文のパターンを設定します

  1. 詳細設定の構成」で説明したように、Jira の詳細設定ページに移動します。
  2. jira.projectkey.pattern プロパティを探し、値をクリックして変更します。以下に一般的な例やパターンのリストを示します。

要求されたパターン

必要な表現

結果の課題 ID

コメント

XXYY、ここで X は 2 つの固定された文字、Y は 2 つの固定された桁数を示す

([A-Z]{2}[0-9]{2})

TQ09-01、TQ09-02、など。

[A-Z] A から Z の任意の文字
{2} 直前の文字に 2 回一致する
[0-9] 0 から 9 の任意の文字 (数字)

XZ+、ここで X は 1 つの固定された文字、Z+ は 1 つ以上の文字、数字、またはアンダーバー記号を表す

([A-Z][A-Z_0-9]+)

ACAT_51-1、AAA5-1330、A_20_A091-15、など。

[A-Z] A から Z の任意の文字
[A-Z]" /> [A-Z_0-9] A から Z および 0 から 9 の任意の文字またはアンダーバー。
+ は [A-Z_0-9] において A から Z および 0 から 9、またはアンダーバーが 1 つ以上あることを指定します。

注意:

  • Jira は指定された正規表現を先頭に「^」を付け、システム内の完全一致ルールには「$」で閉じます。
  • 前述のように、プロジェクトキーは大文字のみをサポートします。したがって、Jira は小文字を大文字に変換するため、簡素化するため、表現には大文字のみを使用してください。

ステップ 2. 正規表現のテスト

さまざまなツールによって、正規表現を使用した検索が可能です。ほとんどのテキストエディターでは、正規表現検索を許可しています。また、インターネット検索で利用可能な正規表現をテストできる、さまざまな Web サイトもあります。

(オプション) ステップ 3. プロジェクトキーの説明と警告をカスタマイズする

ira-config.properties ファイルではプロジェクト キーの書式以外に次のプロパティをカスタマイズできます。

  • jira.projectkey.description — プロジェクト作成時に表示される設定可能な説明 (プロジェクト キーのパターンの照合に使用)
  • jira.projectkey.warning — プロジェクト キーのパターンが jira.projectkey.pattern と一致しないことを Jira が検出すると、jira.projectkey.warning で定義されたエラー メッセージが返されます。このエラー メッセージを変更し、ユーザーのキーの書式が間違っている場合に、使用すべき適切なパターンを通知できます。

関連トピック

最終更新日 2021 年 7 月 1 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.