Инженерия
Changelog как артефакт сборки: соглашения, автоматизация, пайплайны.
С чего начать: Keep a Changelog: объяснение и шаблон CHANGELOG.md, От conventional commits к changelog, Автоматизация changelog: что автоматизировать, а что нет
-
Что такое хотфикс: значение, хотфикс и патч, как выпустить
Хотфикс: срочное исправление вне обычного цикла релизов. Что означает термин, чем он отличается от патча и багфикса и как выпустить его безопасно.
Инженерия5 мин чтения
-
Релиз-кандидат (RC): что это и как его провести
Релиз-кандидатом называют сборку, которая выходит финальной версией, если тесты не найдут блокер. Место RC после беты, версионирование и критерии выхода.
Инженерия4 мин чтения
-
CHANGELOG.md: что в него писать и как держать актуальным
CHANGELOG.md это читательская запись о том, что изменилось в каждой версии. Нужные разделы, полный пример и одна привычка, которая держит файл актуальным.
Инженерия5 мин чтения
-
Release notes на GitHub: сгенерировать и сделать читаемыми
GitHub пишет черновик release notes из влитых pull request в один клик. Что в нём есть, как его формирует release.yml и какая правка делает его читаемым.
Инженерия6 мин чтения
-
Процесс управления релизами для частых выпусков
Процесс управления релизами для софтверных команд в семь шагов, с владельцем и критерием выхода для каждого, плюс метрики DORA и ещё один показатель.
Инженерия7 мин чтения
-
Кто пишет changelog, а кто должен
Кто пишет changelog? Автор PR знает, что изменилось, а PM знает, почему это важно. Ни один из них в одиночку не напишет запись, полезную клиентам.
Инженерия5 мин чтения
-
Форматы файлов changelog: JSON, YAML или просто Markdown
Формат файла changelog решает, может ли он питать страницу и виджет сразу, или его читает только человек. Markdown, JSON и YAML стоят по-разному.
Инженерия5 мин чтения
-
Запись в changelog обязательна: проверка в GitHub Actions
Проверка changelog в GitHub Actions не пускает merge без записи: шаг, который держится на памяти, обязательно забывают. Как её настроить и что она ломает.
Инженерия5 мин чтения
-
Git-теги, релизы GitHub и changelog: в чём разница
Git-тег, релиз и запись changelog фиксируют одно событие трижды. Их смешивание заставляет changelog дрейфовать. Как трём этим вещам следует совпадать.
Инженерия5 мин чтения
-
Changelog монорепозитория: один, или по одному на пакет?
Монорепозиторий может вести один changelog на весь репозиторий или по одному на пакет. Неверный выбор делает релиз либо слишком шумным, либо разрозненным.
Инженерия5 мин чтения
-
Semantic versioning и changelog: что значит каждый скачок
Semantic versioning ещё до чтения changelog говорит, насколько болезненным будет релиз. Что обещает каждая цифра версии и что должна сказать запись.
Инженерия5 мин чтения
-
Публичная страница changelog: как сделать, чтобы читали
Страница changelog оправдывает себя, когда люди возвращаются на неё. Где ей место, что нужно каждой записи, потоки и разметка, и куда встроить виджет.
Инженерия5 мин чтения
-
Автоматизация changelog: что автоматизировать, а что нет
Автоматизируйте сбор, форматирование и публикацию. Не автоматизируйте отбор или формулировку. Где граница и что происходит, когда она сдвигается.
Инженерия6 мин чтения
-
От conventional commits к changelog
Conventional commits делают changelog выводимым из истории, но не делают его читаемым. Что даёт эта конвенция, где она заканчивается и как закрыть разрыв.
Инженерия5 мин чтения
-
Keep a Changelog: объяснение и шаблон CHANGELOG.md
Спецификация Keep a Changelog занимает одну страницу, но команды сбиваются при внедрении. Что она требует, что оставляет на ваше усмотрение и где подводит.
Инженерия5 мин чтения