Добро пожаловать в JIRA Software Server! Этот обзор будет охватывать все, что вам нужно знать, чтобы интегрироваться с JIRA Software Server. Это включает в себя фреймворк P2 для создания надстроек, а также функции и сервисы JIRA Software, которые вы можете использовать при интеграции с JIRA Software.
Привет мир
Если вы уже знаете теорию и хотите перейти прямо в разработку, прочитайте наше руководство по началу работы для создания вашей первой надстройки JIRA Server.
Что такое JIRA Software?
JIRA Software Cloud помогает командам программного обеспечения планировать, отслеживать и выпускать отличное программное обеспечение. Это хостинг-сервис от Atlassian для гибкой разработки программного обеспечения, с функциями планирования спринта, scrum и kanban-досками, гибкими отчетами, панелями мониторинга и т. д. Вы также можете интегрировать JIRA Software Cloud с инструментами управления исходным кодом и непрерывной интеграцией для оптимизации процессов разработки.
Размышляете о создании надстройки или интеграции для JIRA Software? Программное обеспечение JIRA уже используется тысячами компаний, таких как NASA, Spotify и Twitter; и на рынке Atlassian есть более тысячи связанных с JIRA надстроек. Возможности для расширения JIRA Software бесконечны!
Если вы ранее не использовали JIRA Software, ознакомьтесь с обзором продукта для получения дополнительной информации.
Создание надстроек для JIRA Software Server
Если вы хотите создать надстройку для JIRA Software Server, вы должны использовать платформу разработки Atlassian, которая включает фреймворк Plugins2. Надстройки используются для расширения функциональности JIRA Software, которая может быть интеграцией с другим существующим сервисом, новыми функциями для JIRA Software или даже новым продуктом, который работает в JIRA Software.
Основной поток разработки для создания надстройки JIRA Software с использованием Atlassian SDK:
- Создайте свой проект надстройки, как и любую другую надстройку JIRA, например, с помощью команды SDK atlas-create-jira-plugin. Эта команда создает дополнительные файлы надстроек проекта и скелетный код.
- Добавьте любые модули JIRA или общие модули, например. веб-панель, используя модуль атласа-create-jira-plugin. Имейте в виду, что если вы хотите реализовать модуль LinkProvider, вам нужно будет добавить код модуля вручную, как описано здесь.
- Когда вы готовы к созданию и тестированию своей надстройки, запустите команду atlas-package из корневого каталога проекта. Эта команда создает пакетный JAR-файл, который вы можете установить в JIRA.
- Настройте AMPS для запуска JIRA с установленным программным обеспечением JIRA. Если вы еще этого не делали, см. раздел Настройка AMPS для запуска JIRA Core с установленными дополнительными приложениями.
- Запустите JIRA. Для ранней разработки и тестирования вы можете использовать экземпляр разработки, который SDK предоставляет вам при запуске следующей команды (установите версию до 7.0.0 или новее): atlas-run-standalone --product jira -version 7.0.0.
- Войдите в JIRA в качестве администратора, используя комбинацию имени пользователя и пароля по умолчанию admin / admin.
- Установите надстройку, созданную на шаге 2, с помощью команды atlas-package. Вы можете сделать это двумя способами:
- Перейдите в Консоль администрирования и откройте страницу «Управление надстройками». На странице нажмите Загрузить надстройку и выберите файл JAR, созданный для вас командой atlas-package. Вы найдете JAR-файл в каталоге target вашего дома проекта после запуска atlas-package.
- Используя инструменты командной строки SDK: используя терминал, перейдите в домашний каталог проекта и просто запустите плагин atlas-install-plugin (после того, как он упаковал ваш дополнительный JAR с помощью команды SDK atlas-package). Эта команда просто загрузит вашу надстройку в UPM (и может значительно сократить ваш поток разработки).
- Теперь вы должны увидеть свою надстройку в пользовательском интерфейсе JIRA Software. Каждый раз, когда вы меняете свой код надстройки или ресурс, перезагрузите надстройку, снова запустив команду atlas-package, а затем удалите и переустановите файл JAR надстройки на странице «Управление надстройками».
Если вы еще не создали надстройку, ознакомьтесь с руководством по началу работы. Это руководство поможет вам узнать, как настроить среду разработки и создать надстройку JIRA Server.
Разработка с помощью Plugins2
Если вы создаете надстройку с помощью Plugins2, вам также нужно будет понять ряд ключевых процессов разработки:
- Внедрение безопасности: внедрение безопасности является важной частью интеграции с JIRA. Подробнее об аутентификации и авторизации для JIRA Server см. в Обзор безопасности.
- Перечисление ваших надстроек на Atlassian Marketplace и внедрение лицензирования: список вашего дополнения на Atlassian Marketplaces и лицензирование необходимы, если вы хотите сделать свою надстройку доступной для общественности. Дополнительную информацию см. в Документация Marketplace.
-
Проектирование вашей надстройки: поскольку надстройки Plugins2 могут вставлять контент непосредственно в приложение Atlassian host, крайне важно, чтобы надстройки были визуально совместимы с дизайном приложения Atlassian. Наши дизайнеры и разработчики создали ряд ресурсов, которые помогут вам в этом:
- Atlassian Design Guidelines - наши руководящие принципы проектирования определяют основные взаимодействия с приложениями Atlassian.
- Atlassian User Interface (AUI) - AUI - это библиотека многократно используемых интерфейсных компонентов интерфейса.
Строительные блоки для интеграции с JIRA Software Server
Три основных блока интеграции с JIRA Software - это API, веб-узлы и модули.
API-интерфейсы API JIRA
API-интерфейсы JIRA Software Server позволяют интегрировать вашу интеграцию с JIRA Software Server. Например, используя REST API, вы можете написать скрипт, который перемещает задачи из одного спринта в другой. Для большинства других интеграций вы должны использовать REST API. API Java следует использовать только в том случае, если вы создаете надстройку Plugins2.
- JIRA Software Server REST API (последняя версия)
- JIRA Software Server Java API (все версии)
Примечание. Программное обеспечение JIRA построено на платформе JIRA, поэтому вы можете использовать API-интерфейс REST API-платформы JIRA (новейший) и API-интерфейс серверной Java-платформы JIRA (последняя версия) для взаимодействия с JIRA Software Server.
Webhooks и правила автоматизации
Надстройки и приложения могут реагировать на условия / события в JIRA Software через правила автоматизации. Вы можете реализовать «действие автоматизации», которое выполняет действия в удаленной системе как часть правила автоматизации. Также можно настроить правило автоматизации для запуска webhooks, которые уведомляют ваше дополнение или приложение. Для получения дополнительной информации см. Webhooks.
Программные модули JIRA
Модуль - это просто элемент пользовательского интерфейса, например вкладка или меню. Модули UI программного обеспечения JIRA позволяют надстройкам взаимодействовать с пользовательским интерфейсом JIRA Software. Например, ваше дополнение может использовать модуль интерфейса JIRA Software UI, чтобы добавить новое раскрывающееся меню на плату. Дополнительные сведения см. в разделе О модулях JIRA.
JIRA Software Server и платформа JIRA
JIRA Software - это приложение, созданное на платформе JIRA. Платформа JIRA предоставляет набор базовых функциональных возможностей, которые распределяются между всеми приложениями JIRA, такими как задачи, рабочие процессы, поиск, электронная почта и т. д. Приложение JIRA является расширением платформы JIRA, которая обеспечивает определенную функциональность. Например, JIRA Software добавляет доски, отчеты, интеграцию инструментов разработки и другие гибкие возможности разработки программного обеспечения.
Это означает, что когда вы разрабатываете JIRA Software, вы фактически интегрируетесь с программным приложением JIRA, а также с платформой JIRA. Программное обеспечение JIRA и платформа JIRA имеют свои собственные API REST, события webhook и веб-фрагменты.
Прочтите документацию об платформе JIRA Server для получения дополнительной информации.
Ищете вдохновение?
Если вы ищете идеи по созданию следующей интеграции JIRA Software Cloud, вот несколько примеров того, что вы можете создать поверх JIRA Software Cloud:
- Ретроспективные инструменты для JIRA Это дополнение предоставляет ряд инструментов для анализа истории реализации вашего проекта и с помощью API-интерфейса JIRA, в числе прочего позволяющее сравнивать и оценивать качество организации нескольких проектов.
- Epic Sum Up - эта надстройка добавляет панель на страницу с обзором задач, которая позволяет вам просмотреть ваш эпический прогресс или каждую задачу в эпосе.
- Tempo Planner для JIRA - это дополнение извлекает информацию из досок, эпосов и отставаний с использованием API-интерфейса JIRA и позволяет вам планировать свою работу членом команды.
Больше информации
- Обучающие программы JIRA Software Cloud - Узнайте больше о разработке JIRA Software, попробовав одно из наших практических руководств.
- jira-agile-development tag на форуме Atlassian Answers - Присоединяйтесь к обсуждению разработки JIRA Software.
По материалам Atlassian JIRA Server Developer Integrating with JIRA Software Server