Изменение формата проектного ключа

JIRA предоставляет возможность указывать формат ключей проекта в системе. Это позволяет ограничить формат ключа проекта, когда создается или редактируется ключ проекта.

Формат ключевого слова проекта определяется с помощью регулярного выражения «правило», которое определяет допустимый формат ключа проекта. По умолчанию для конфигурации ключа проекта JIRA требуются два или более заглавных алфавитных символа - на основе регулярного выражения ([A-Z] [A-Z] +).

Прежде чем вы начнете

Убедитесь, что вы выбрали поддерживаемый формат ключа проекта (supported project key format). Поддерживаются только форматы, соответствующие всем следующим правилам:
- Первым символом должен быть буква.
- Все буквы, используемые в ключе проекта, должны быть от современного римского алфавита и верхнего регистра, и
- Можно использовать только буквы, цифры или символ подчеркивания.

Примеры:

Примеры поддерживаемых ключей: PRODUCT_2013, R2D2, MY_EXAMPLE_PROJECT.
Примеры неподдерживаемых ключей: 2013PROJECT (первый символ не является буквой), PRODUCT-2012 (дефисы не поддерживаются).

Вы не можете настроить шаблон ключа задачи, поскольку JIRA ожидает, что этот ключ будет соответствовать определенным правилам. По умолчанию ключи выпуска JIRA (или идентификаторы ошибок) имеют формат <ключ проекта> - <номер задачи>, например. АВС-123. Например, вы не можете показать номер задачи перед ключом проекта.
Если в вашей установке JIRA уже был создан ряд задач, изменение формата ключа проекта не рекомендуется. Если вы должны изменить шаблон ключа проекта после того, как задачи уже созданы, используйте регулярное выражение, которое позволяет использовать более «разрешительный» шаблон ключа проекта, чем текущий (например, использовать регулярное выражение, которое все равно будет действительным для существующих ключей проекта, определенных в вашей установке JIRA).
Если вы используете JIRA Agile и используете Classic Boards («Классические доски»), не изменяйте формат ключа проекта по умолчанию JIRA, поскольку Classic Boards поддерживают только этот формат ключа. Если вы не используете Classic Boards, вы можете перейти к поддерживаемому формату ключа проекта.

Если вы интегрировали JIRA с Bamboo, не изменяйте формат ключа проекта по умолчанию JIRA, поскольку Bamboo поддерживает только этот формат ключа.

Настройка формата ключа проекта

Свойство jira.projectkey.pattern позволяет администраторам JIRA указывать значение регулярного выражения Perl5, которое определяет правило для действительного ключа проекта. Дополнительную информацию о Perl5 можно найти здесь.

Это свойство и его значение регулярного выражения можно определить на странице «Дополнительные параметры» (Advanced Settings ). Это описано ниже.

Шаг 1. Настройте шаблон для синтаксиса вашего проекта

Перейдите на страницу дополнительных настроек JIRA, как описано в разделе «Конфигурирование расширенных настроек ».
Найдите свойство jira.projectkey.pattern и щелкните его значение, чтобы изменить его. Ниже приведен список общих примеров и шаблонов:

Запрошенный шаблон

Требуемое выражение

Результирующие идентификаторы запросов

Комментарии

XXYY, где X обозначает две фиксированные буквы, Y представляет две фиксированные цифры

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

TQ09-01, TQ09-02, и т.д.

[A-Z] Любой символ от А до Я

{2} Соответствует предыдущему символу 2 раза точно

[0-9] Любой символ (например, digit) от 0 до 9

XZ +, где X обозначает одну фиксированную букву, Z + представляет одну или несколько букв, цифр или символов подчеркивания

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

ACAT_51-1, AAA5-1330, A_20_A091-15,

[A-Z] Любые символы от А до Я

[A-Z_0-9] Любой символ от A до Z, от 0 до 9 или символ подчеркивания.

+ указывает [A-Z_0-9] как один или несколько символов от A до Z, от 0 до 9 или символ подчеркивания.

Пожалуйста, обратите внимание:

JIRA добавляет регулярное выражение, указанное с помощью «^», и закрывает его «$» для точного правила соответствия в системе.
Ключ проекта поддерживает только символы верхнего регистра, как указано выше. Следовательно, для простоты используйте символы верхнего регистра в ваших выражениях, поскольку JIRA преобразует любые строчные символы в верхние регистры.

Шаг 2. Проверьте свое регулярное выражение

Различные инструменты позволяют выполнять поиск с использованием регулярного выражения. Большинство текстовых редакторов позволят искать регулярные выражения. Существуют также различные веб - сайты, доступные для тестирования регулярного выражения, доступного из поиска в Интернете.

(Необязательно) Шаг 3. Настройте описание и предупреждение о ключе проекта

В дополнение к формату ключа проекта вы также можете настроить следующие свойства в файле jira-config.properties:

jira.projectkey.description - настраиваемое описание (в соответствии с шаблоном ключа проекта), отображаемое при создании проекта

jira.projectkey.warning - если JIRA обнаруживает, что введенный ключ проекта не соответствует jira.projectkey.pattern, он выдает сообщение об ошибке, определенное в jira.projectkey.warning. Вы можете изменить это сообщение об ошибке, чтобы при нажатии пользователем неправильного формата они будут проинформированы о правильном шаблоне для использования.