Кальтер / Блог

Как подготовить черновик release notes с ИИ по merged pull requests

Владелец software-проекта хочет превратить merged PR между двумя тегами в короткие release notes и не включить работу, не вошедшую в релиз.

Материал подготовлен с помощью ИИ; источники и примеры проверены редакцией ZASLON. Учебные примеры не описывают результаты клиентов.

Что вошло в релиз — поясняющая схема
Редакционная схема: Что вошло в релиз. Условные обозначения, не реальные результаты клиента.

Попроси ИИ преобразовать подтверждённый список слитых изменений в черновик для читателя, а не самостоятельно определять, что попало в релиз. Источник истины — фактически выбранный релизный диапазон и его merged pull requests; незлитые PR, черновые задачи и неподтверждённые обещания должны остаться за пределами текста. GitHub автоматические release notes также строит вокруг merged PR и позволяет настраивать категории, но рекомендует проверить, что попали все и только нужные изменения (GitHub Docs).

Подготовь входные данные

До запроса модели зафиксируй предыдущий и текущий теги, список merged PR, категории, аудиторию и опубликованные факты о поведении продукта. Для каждого PR добавь короткое резюме, подтверждённое автором изменения, и ссылку на задачу или документацию. Не передавай секреты, внутренние комментарии или персональные данные без разрешения.

Промпт должен чётко ограничить роль модели: использовать только переданные PR; не дописывать функциональность; сохранять неопределённость; помечать незнакомые технические детали как вопросы; не включать issue или PR со статусом draft/open. Например:

Подготовь черновик заметок выпуска для пользователей на русском. Используй только PR из списка со статусом merged между тегами v1.4 и v1.5. Раздели изменения на «Добавлено», «Исправлено», «Требует внимания». Не обещай поведение, которого нет в summary. Для каждой строки приложи номер PR. Если влияние неясно, напиши НУЖНА ПРОВЕРКА и объясни вопрос. Исключи open и draft PR.

Синтетический пример фильтрации

Пусть в наборе есть PR #41 со статусом merged, который добавляет экспорт CSV; #42 merged, исправляющий поведение пустого фильтра; и #43 со статусом draft, где описана планируемая интеграция. В черновик можно включить первые две записи, если они действительно входят в диапазон релиза. #43 исключается независимо от того, насколько убедительно его описание звучит.

До выпуска редактор сравнивает каждую строку с PR и проверяет: статус merge, включение в release range, фактическое поведение, аудиторию, обратную совместимость, флаг/план развертывания и тарифные формулировки. Тарифы и коммерческие обещания сверяй отдельно с владельцем продукта. Результат — проверяемый текст со ссылкой на источник, а не подтверждение качества продукта.

Образец результата для проверки

Ниже редакционный учебный образец, а не результат запуска модели:

  • Добавлено: экспорт данных в CSV — PR #41. Перед публикацией уточнить, какие данные экспортируются и кому доступна функция.
  • Исправлено: обработка пустого фильтра — PR #42. НУЖНА ПРОВЕРКА: summary не описывает прежнее и новое поведение, поэтому пользовательскую формулировку должен подтвердить разработчик.

PR #43 в тексте отсутствует: он ещё draft. Даже merged PR может не попасть в выбранный тег или оставаться выключенным feature flag. До выпуска проверь включение в сборку и фактическую доступность функции; слияние кода само по себе не означает развёртывание.

Приёмка по строкам

Вопрос редактора Прошло, если…
Есть ли первоисточник? Каждое утверждение связано с merged PR или документацией
Входит ли изменение в релиз? Тег/диапазон и статус подтверждены
Понятно ли пользователю? В тексте описан эффект, а не только внутренний код
Нет ли выдумки? Модель не добавила функции, цифры и обещания
Нужна ли ручная проверка? Сложные или коммерчески значимые строки подтверждены ответственным

Для оценки такого процесса используй набор примеров с ожидаемым содержанием и проверяй ошибки отдельно по типам: пропуск важного изменения, выдуманная функция, неверное объяснение и включённый незлитый PR. OpenAI описывает оценивание как проверку конкретной задачи по заданным критериям и примерам; сама рекомендация не доказывает, что выбранная модель или промпт точны (Evaluation best practices). Не публикуй сгенерированный текст без review разработчика и владельца релиза.

Проверку самого изменения отделяй от редакционной работы: для кода используй чек-лист AI code review.