Release Timeline — визуализация GitHub релизов в вашей документации
Данное приложение было создано для красивого и удобного показа изменений во Vue 3 проекте в его документации на VitePress. После оно было сделано универсальным, и может быть подключено в любой HTML странице как Web component или микрофронтенд.
Потестировать — https://vuesence.github.io/release-timeline/. Слева вверху можно указать любой публичный репозиторий.
Цель
В документации програмных проектов обычно есть `changelog`. Вести его вручную довольно неудобно, а показывать пользователю `changelog` или список коммитов из репозитория не очень user-friendly.
Например, на проекте vue-faq.org часто происходят изменение и добавление контента. Людям, которые уже были на сайте, нужен способ увидеть, что новое появилось за это время. Вручную описывать все изменения на отдельной странице — очень времязатратно.
Формат `release-timeline` с одной стороны визуально приятен и компактен, с другой — достаточно функционален.
Также можно отметить, что после задействования в документации проекта `release-timeline`, относишься к названию коммитов и pull requests намного ответственней. Также, как и к описанию релизов. Подбор названий релизов — повод для фантазии. В моем случае, фантазии ChatGPT с промптом:»generate 5 dragon names»
Как установить
Библиотека может быть использована во Vue 3 проекте, в VitePress (с поддержкой тем и стилей), как Web component или микрофронтенд на произвольном сайте. Подробней — в документации.
Библиотека без зависимостей, код — 5Кб в GZip при подключении во Vue 3 проект, и 60Кб (вместе с Vue 3 дистрибутивом) при подключении как Web component или микрофронтенд.
