Использование HTML в описаниях задач Jenkins: решение

Пройдите тест, узнайте какой профессии подходите

Я предпочитаю
0%
Работать самостоятельно и не зависеть от других
Работать в команде и рассчитывать на помощь коллег
Организовывать и контролировать процесс работы

Быстрый ответ

Вам потребуется плагин Safe HTML, чтобы вкладывать HTML код в описания задач Jenkins. Воспользуйтесь приведенной ниже инструкцией:

  1. Перейдите в раздел Управление Jenkins, затем выберите Настройки глобальной безопасности.
  2. В разделе Форматирование разметки выберите значение Safe HTML.

Вот пример использования HTML:

HTML
Скопировать код
<b>Сборка:</b> <span style="color:green;">Успешно</span>

Учтите, что использовать можно только ограниченный набор HTML-тегов в интересах безопасности.

Кинга Идем в IT: пошаговый план для смены профессии

Плагины и настройка

Возьмем на вооружение несколько способов разнообразить описания ваших задач в Jenkins:

Установка Safe HTML с помощью веб-интерфейса

Быстрый способ:

  1. Находим пункт Управление Jenkins, далее переходим в раздел Настройки глобальной безопасности.
  2. Найдите опцию Форматирование разметки и переключите её на Safe HTML, чтобы включить возможности использования HTML.

Программное включение с плагином JASC

Если вы предпочитаете подход программирования через Configuration as Code, воспользуйтесь плагином CASC:

  1. Ваш файл конфигурации должен содержать строку markupFormatter: safeHtml.
  2. Примените настройки, и ваши задачи смогут включать в себя описания с использованием HTML!

Плагин CASC идеален для широкомасштабной настройки инстансов Jenkins, превращающий вашу конфигурацию в версионируемую и тестируемую.

Обновления

Jenkins часто обновляется, поэтому всегда просмотривайте релизные заметки и проверяйте, совместимы ли ваш и поддерживаемая версия Jenkins.

Подробнее об этом расскажет наш спикер на видео
skypro youtube speaker

Визуализация

Представьте Jenkins как холст (🖼️), надёжно укрепленный в сейфе (🔒). Вы хотите внести в ваши задачи красок с помощью HTML, но Jenkins требует мер безопасности. Он ограничивает, какой разметкой (красками) вы можете воспользоваться.

Markdown
Скопировать код
Ваш набор инструментов:
- Карандаш (✏️) = Простой текст
- Гуашь (🖌️) = Ограниченный HTML
- Масло (🛢️) = Полный HTML (но Jenkins здесь вмешивается: "Нет, это слишком опасно")
Markdown
Скопировать код
На холсте описаний в Jenkins:
- 🖼️✏️: "Примените простой текст для описания"
- 🖼️🖌️: "Включайте базовый HTML для стильного форматирования"
- 🖼️🚫🛢️: "Сложный HTML, JS или CSS используйте вне Jenkins"

Оживите свои задачи, используя ограниченный HTML, чтобы превратить описание в истинное произведение искусства!

Советы и подводные камни

Использование HTML в описаниях задач Jenkins может принести свои трудности, но мы поможем вам их обойти:

Подсветка синтаксиса

При включении HTML убедитесь, что параметр disableSyntaxHighLighting имеет значение false в настройках Jenkins. Это облегчит чтение кода.

Markdown
Скопировать код
// Ведь подсветка синтаксиса делает код привлекательнее, не так ли?

Навигация по ссылкам

Внутренние ссылки, которые предоставляет Jenkins при настройке конфигурации безопасности, невероятно полезны. Используйте их, чтобы избегать ошибок.

Markdown
Скопировать код
// Не стесняйтесь кликать на эти синие ссылки – они только помогут

Безопасное использование HTML

Прежде чем начать работу, убедитесь, что ваш HTML не включает активные элементы, такие как JavaScript или сложные CSS. Деликатно подходите к вопросу безопасности и не подвергайте Jenkins риску атак.

Markdown
Скопировать код
// Поставьте безопасность на первое место. Jenkins ценит безопасный код, возможно, даже больше, чем утренний кофе.

Полезные материалы

  1. GitHub – jenkinsci/antisamy-markup-formatter-plugin — Источник информации и документация для форматировщика Safe HTML.
  2. OWASP Markup Formatter | Jenkins plugin — Всё, что вам нужно знать о настройке и использовании плагина.
  3. Настройка политики безопасности контента — Инструкция по настройке Jenkins для безопасного отображения HTML.
  4. DZone: Добавление пользовательских значков к заданиям Jenkins — Разукрашиваем описания задач Jenkins с помощью значков для улучшения визуального восприятия.
  5. Документация плагинов как код: Переход документации на GitHub — Подход Jenkins к настройке с использованием CSS и JavaScript.
  6. Официальный образ Jenkins для Docker — Тестируйте настройки Jenkins локально в Docker.