Красивые release notes на drupal.org

Главные вкладки

ivnish 2 февраля 2020 в 19:20
5

Задался я сегодня вопросом, как на drupal.org делают "красивые" release notes. Например https://www.drupal.org/project/jsonapi/releases/8.x-2.1

Красивость в том, что номер issue является ссылкой на issue, а имя пользователя ссылкой на пользователя. Плюс есть разделение по типу issue (bug, task, feature)

Выяснилось, что есть инструмент помогающий в этом. Это drupalorg-cli

Пример использования:

1) Переходим в каталог, где находится .git вашего модуля
2) Запускаем drupalorg rn 8.x-1.0, где 8.x-1.0 это номер ПРЕДЫДУЩЕЙ версии
3) Получаем в ответ что-то вроде

<p><em>Add a summary here</em></p>
<h3>Contributors (1)</h3>
<p><a href="https://www.drupal.org/u/ivnish">ivnish</a></p>
<h3>Changelog</h3>
<p><strong>Issues:</strong> 2 issues resolved.</p>
<p>Changes since <a href="https://www.drupal.org/project/visually_impaired_module/releases/8.x-1.0">8.x-1.0</a>:</p>
<h4>Feature</h4>
<ul>
  <li><a href="https://www.drupal.org/node/3110474">#3110474</a> by <a href="https://www.drupal.org/u/ivnish">ivnish</a>: Allow choose image or text in the block</li>
</ul>
<h4>Task</h4>
<ul>
  <li><a href="https://www.drupal.org/node/3025823">#3025823</a> by <a href="https://www.drupal.org/u/ivnish">ivnish</a>: Fix coding standards</li>
</ul>

4) Вставляем этот код в release notes вашего модуля на drupal.org при создании нового релиза.

Выглядит это примерно вот так

Автор

ivnish Drupal FullStack Developer

Комментарии