В этом документе содержатся инструкции по созданию заметок о выпуске для Android Studio.
Цель
Для создания подробных заметок о выпуске для коммитов из репозитория GitHub.
Инструкции
Последовательно и полностью следуйте данным инструкциям.
Шаг 1: Клонируйте или обновите репозиторий
Проверьте наличие папки studio-main в этом проекте. Если её нет, клонируйте репозиторий studio-main с помощью следующей команды:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Если каталог уже существует, обновите его, скачав содержимое репозитория из GitHub.
Прежде чем продолжить, сообщите мне статус studio-main.
Шаг 2: Изучите репозиторий
Изучите содержимое репо.
Шаг 3: Получите коммиты
Отправьте все коммиты в основной репозиторий студии в течение указанного мной срока. Сообщите мне количество коммитов, прежде чем продолжить. Для подсчёта коммитов всегда используйте команду wc -l.
Определите целевые коммиты: из журнала git извлеките полный блок коммитов для каждого коммита, содержащего точную строку «Relnote:
" где Название продукта, которое я указал. Если я не укажу название продукта, просто найдите «Relnote». «Блок коммита» включает хэш коммита, автора, дату, полное сообщение о коммите и разницу в коде.
Используйте правильный инструмент: чтобы отфильтровать коммиты по диапазону дат и названию продукта, используйте следующую команду:
git log --after="
" --before=" " --grep="Примечание: " где
и это тот диапазон дат, который я вам дал, и это название продукта, которое я вам дал. Если название продукта не указано, просто используйте следующую команду:
git log --after="
" --before=" " --grep="Relnote" Подтвердите количество: покажите мне общее количество, хеши и названия всех обнаруженных вами коммитов. Я дам вам подтверждение для продолжения.
Шаг 4: Создайте подробные заметки о выпуске
Проанализируйте каждый коммит: Для каждого из коммитов, определенных на предыдущем этапе, выполните подробный анализ, который включает в себя:
- Чтение полного сообщения о коммите.
- Проверка разницы в коде (git show
), чтобы понять изменение. - Следите за всеми связанными ошибками (например, Ошибка: 12345678), чтобы собрать больше контекста.
Прежде чем продолжить, согласуйте со мной детали.
Проанализируйте все связанные документы в папке docs на предмет информации, касающейся изменений. Используйте эту информацию для создания содержательного примечания к выпуску.
Прежде чем продолжить, сообщите мне, какие коммиты содержат соответствующую информацию в папке docs.
Найдите все ошибки, упомянутые в коммитах. Используйте информацию из сообщения об ошибке для создания примечания к выпуску для коммита.
Напишите примечание к выпуску: для каждого коммита напишите примечание к выпуску, которое включает:
Ссылка на коммит: перед каждой заметкой о выпуске добавьте комментарий Markdown, содержащий хэш исходного коммита, например: .
Четкое название: краткое, изложенное в предложениях краткое содержание изменения.
Подробное объяснение: абзац, объясняющий суть изменения.
Ключевые моменты изменения в следующем порядке:
а. Почему: Что изменилось и почему. б. Влияние: Влияние на разработчиков приложений. в. Миграция: Путь миграции (если есть).
Примеры кода «до» и «после». Если фиксация подразумевает изменение кода, с которым сталкивается пользователь (например, изменения DSL в файлах .gradle или модификации API), предоставьте понятные и краткие фрагменты кода, демонстрирующие это изменение.
Следуйте стилю примечаний к выпуску по адресу https://developer.android.com/studio/releases.
Шаг 5: Запишите заметки о выпуске в файл Markdown.
- Создайте файл Markdown с именем release-notes-YYYY-MM-DDTHH:MM.md в корне проекта, где в формате ISO 8601 — YYYY-MM-DD (год-месяц-день) — текущая дата, T — разделитель, а HH:MM (часы:минуты в 24-часовом формате) — текущее время.
- Напишите введение, объясняющее цель примечаний к выпуску.
- Напишите краткое изложение примечаний к выпуску.
- Напишите полные, отформатированные заметки о выпуске.
Шаг 6: Создайте коммит
Создайте коммит Fig для файла с заметками о выпуске. Не указывайте идентификатор ошибки.
Шаг 7: Создайте список изменений
Создайте CL коммита.