Замена ссылок на импортированные задачи и страницы
Документ описывает инструкцию по замене ссылок на импортированные из Jira и Confluence задачи и страницы. После импорта в описанииях и комментариях задач и страниц могут оставаться ссылки на объекты в системах из которых выполнен импорт. Скрипт заменяет их ссылки на аналогичные объекты в TeamStorm.
Порядок запуска
Перед запуском скрипта убедитесь, что выполнен импорт всех необходимых пространств, ссылки на которые существуют в описаниях импортированнх задач. Все страницы, на которые есть ссылки, должны быть импортированы в TeamStorm перед запуском. Также перед запуском следует увеличить допустимое время редактирования комментариев. Воспользуйтесь инструкцией Настройка допустимого времени редактирования комментариев
Исходные данные
Для добавления межпроектных связей потребуются следующие данные:
- архив со скриптами импорта
- URL сервера TeamStorm
- токен аутентификации пользователя TeamStorm
- URL сервера Confluence
- персональный токен доступа пользователя Confluence
Подготовка запуска
- Установите среду выполнения Python 3.11.
-
Установите следующие модули:
-
Распакуйте архив со скриптами миграции
Получение токена аутентификации TeamStorm
Для аутентификации в API TeamStorm необходимо выбрать учетную запись пользователя, у которого есть системные роли "Администратор Core" и "Пользователь TeamStorm".
- Авторизуйтесь в TeamStorm в браузере с выбранной учетной записью.
- Откройте веб-инспектор браузера.
- Откройте любой запрос TeamStorm.
-
Скопируйте из заголовка запроса Authorization токен авторизации (символы без "Bearer").
Создание токена Confluence
- Авторизуйтесь в Confluence с выбранной учетной записью.
- Создайте и сохраните персональный ключ доступа в профиле пользователя согласно документации Atlassian Using Personal Access Tokens
Основные параметры скрипта
-
- URL сервера TeamStorm -
- токен аутентификации пользователя TeamStorm -
- URL сервера Confluence -
- персональный токен доступа пользователя Confluence
Дополнительные параметры скрипта
Выбор пространств TeamStorm для поиска и замены задач и страниц
По умолчанию поиск и замена будет выполняется по всем пространствам. Для ограничения замены и поиска только определненными пространствами можно передать их ключи через параметр --ts_spaces
:
Выбор пространств Confluence для поиска страниц
Для оптимизации времени выполнения скрипта можно ограничить поиск страниц в Confluence только теми простанствами, для которых существуют ссылки. По умолчанию поиск выполняется по всем пространствам, что может существенно увеличить время импорта. Для поиска страниц только в определенных пространствах, из которых проводился импорт, можно передать их названия через параметр --c_spaces:
Запуск скрипта
- Перейдите в папку со скриптами
-
Выполните команду c необходимыми параметрами
python3 migrate_description_urls.py <ts_url> \ <ts_bearer> \ <с_url> \ <с_token> [Дополнительные параметры скрипта]
Пример вызова скрипта:
-
Дождитесь выполнения скрипта
- Проверьте, что ссылки на страницы и задачи в описаниях и комментариях заменены на ссылки аналогичных задач и страниц, импортированных в TeamStorm