Skip to content

docs: Полный и выверенный changelog - #39

Merged
GulomovCreative merged 1 commit into
masterfrom
docs/changelog
Sep 25, 2026
Merged

GulomovCreative merged 1 commit into
masterfrom
docs/changelog

Conversation

@GulomovCreative

Copy link
Copy Markdown
Owner

Зачем

В changelog не было линии 3.x, часть дат не совпадала с релизами, ссылки вида [#11] не работали, а раздел 4.0.0 рос дописками и читался тяжело. Теперь это полная и выверенная история FetchIt.

Что меняется

  • Обе линии. Добавлены версии 3.0.0–3.1.4 из ветки next. Вверху сказано, что 1.x была для MODX 2, 3.x для MODX 3, а 4 заменяет обе.
  • Даты взяты по публикации релизов на GitHub, для версий без релиза по коммиту выпуска. Например, 1.0.0 теперь 2023-03-20, а не 2023-03-10.
  • Ссылки.
    • У каждой версии ссылка на сравнение с предыдущей, я проверил все 13.
    • Номера issues и PR стали ссылками, все 12 открываются.
    • Для 1.1.2, 3.1.2 и 3.1.3 тегов нет, поэтому ссылки ведут на коммиты выпуска.
    • Тег 3.1.1-pl по ошибке стоит на коммите линии 1.x, поэтому ссылка 3.1.1 ведёт на настоящий коммит релиза в next. Сам тег я не трогал.
  • Раздел 4.0.0 разложен по категориям Keep a Changelog: Added, Changed, Removed, Fixed, Security.
    • Несовместимые изменения помечены Breaking.
    • В Security вынесены две дыры, которые 4.0 закрыл: POST прямо на страницу мимо проверок и AJAX-режим FormIt 5.2.
    • Добавлен пункт про сборку в ES2019.
  • Старые записи вроде «Fixed support in php 8» переписаны по реальным изменениям: какой именно была ошибка и что починили.

Заметки для ревью

  • Проверка версии и релизный workflow ищут раздел по строке ## [X.Y.Z], формат заголовков не менялся. version.php с v4.0.0 проходит, раздел 4.0.0 находится.
  • Файл показывается в Менеджере пакетов MODX как текст, поэтому ссылки собраны внизу, а не внутри строк.
  • Заметки уже опубликованного релиза v4.0.0 на GitHub после слияния можно обновить этим текстом.

@GulomovCreative
GulomovCreative merged commit 64df3f7 into master Sep 25, 2026
16 checks passed
@GulomovCreative
GulomovCreative deleted the docs/changelog branch September 25, 2026 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant