プロジェクトキーの形式の変更
JIRA はシステム内で、プロジェクトキーの書式を指定する機能を提供します。これによりプロジェクトキーが作成または編集された時のプロジェクトキーの書式を制限できます。
A project key format is defined via a regular expression 'rule' that governs the valid project key format. By default, the JIRA project key configuration requires two or more uppercase alphabetical characters — based on the regular expression ([A-Z][A-Z]+
).
はじめる前に
- サポートされているプロジェクトキー形式を選択したことを確認します。次のルールをすべて満たす書式のみがサポートされます:
- 最初の文字はアルファベットにする必要があり、
- プロジェクトキーに使用するすべての文字はモダン ローマン体の大文字を使用し、
- 文字、数字、アンダースコア記号のみを使用できます。
例:- サポートされるキーの例:
PRODUCT_2013
、R2D2
、MY_EXAMPLE_PROJECT
。 - サポートされないキーの例:
2013PROJECT
(最初の文字がアルファベットでない)、PRODUCT-2012
(ハイフンはサポートされません)。
- サポートされるキーの例:
- JIRA はこのキーが特定のルールを順守することを期待しているため、課題キーのパターンを設定することはできません。既定では、JIRA 課題キー (または課題 ID) の形式は<project key>-<issue number> です。例: ABC-123。 たとえば、プロジェクトキーの前に課題番号を示すことはできません。
- JIRA インストールで既に多数の課題が作成されている場合、プロジェクトキーの形式を変更することはお勧めしません。課題を既に作成した後でプロジェクトキーのパターンを変更する必要がある場合は、現在のものよりもさらに「許容可能な」プロジェクトキーのパターンが可能な正規表現を使用します (例: JIRA インストールで定義された既存のプロジェクトキーでまだ有効な正規表現を使用する)。
JIRA を Bamboo と統合した場合、JIRA の既定のプロジェクトキーの書式を変更しないでください。Bamboo でサポートされるのはこのキー形式のみです。
プロジェクトキーの形式の設定
The jira.projectkey.pattern
property allows JIRA administrators to specify a Perl5 regular expression value that defines the rule for a valid project key. Further information on Perl5 is available here.
このプロパティおよび正規表現値は、「詳細設定」ページで定義できます。これについては、以下で説明します。
手順 1.プロジェクトキー構文のパターンを設定します
- 「詳細設定の構成」で説明したように、JIRA の詳細設定ページに移動します。
- Find the
jira.projectkey.pattern
property and click its value to modify it. Below is a list of common examples and patterns:
要求されたパターン | 必要な表現 | 結果の課題 ID | コメント |
---|---|---|---|
XXYY、ここで X は 2 つの固定された文字、Y は 2 つの固定された桁数を示す | ( | TQ09-01、TQ09-02、など。 |
|
XZ+、ここで X は 1 つの固定された文字、Z+ は 1 つ以上の文字、数字、またはアンダーバー記号を表す | ( | ACAT_51-1、AAA5-1330、A_20_A091-15、など。 |
|
注意:
- JIRA は指定された正規表現を先頭に「^」を付け、システム内の完全一致ルールには「$」で閉じます。
- 前述のように、プロジェクトキーは大文字のみをサポートします。したがって、JIRA は小文字を大文字に変換するため、簡素化するため、表現には大文字のみを使用してください。
ステップ 2. 正規表現のテスト
さまざまなツールによって、正規表現を使用した検索が可能です。ほとんどのテキストエディターでは、正規表現検索を許可しています。また、インターネット検索で利用可能な正規表現をテストできる、さまざまな Web サイトもあります。
(オプション) ステップ 3. プロジェクトキーの説明と警告をカスタマイズする
In addition to the project key format, you can also customize the following properties in the jira-config.properties
file:
jira.projectkey.description
— プロジェクト作成時に表示される設定可能な説明 (プロジェクト キーのパターンの照合に使用)jira.projectkey.warning
— if JIRA detects that the project key entered does not match thejira.projectkey.pattern
, it will throw the error message defined injira.projectkey.warning
. You can change this error message, so that when a user keys in the wrong format, they will be informed of the correct pattern to use.
関連トピック
- プロジェクト キーの最大の長さを変更する — プロジェクト キーで使用可能な最大文字数を変更できます。「Jira アプリケーションのオプションの構成」に従って Jira 管理コンソールの [一般設定] ページに移動し、[プロジェクト キーの最大サイズ] フィールドを変更します。
- プロジェクトの定義
- プロジェクト キーの編集
- 詳細設定の構成