En este documento, se incluyen instrucciones para crear las notas de la versión de Android Studio.
Objetivo
Crea notas de la versión detalladas para las confirmaciones de un repositorio de GitHub.
Instrucciones
Sigue estas instrucciones de forma secuencial y completa.
Paso 1: Clona o actualiza el repositorio
Verifica si hay una carpeta studio-main en este proyecto. Si no existe, clona el repositorio studio-main con el siguiente comando:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Si el directorio ya existe, actualízalo extrayendo el contenido del repo de GitHub.
Avísame el estado de studio-main antes de continuar.
Paso 2: Estudia el repo
Estudia el contenido del repo.
Paso 3: Obtén las confirmaciones
Obtén todas las confirmaciones enviadas al repositorio studio-main durante el período que te proporcioné. Dime el recuento antes de continuar. Siempre usa wc -l para el recuento.
Identifica las confirmaciones de destino: Del registro de Git, extrae el bloque de confirmación completo para cada confirmación que contenga la cadena exacta "Relnote:
", donde es el nombre del producto que proporcioné. Si no proporciono un nombre de producto, solo busca "Relnote". Un "bloque de confirmación" incluye el hash de confirmación, el autor, la fecha, el mensaje de confirmación completo y el diff del código.
Usa la herramienta correcta: Para filtrar las confirmaciones por período y nombre del producto, usa el siguiente comando:
git log --after="
" --before=" " --grep="Relnote: " donde
y son el período que te proporcioné, y es el nombre del producto que te proporcioné. Si no se proporciona un nombre de producto, usa el siguiente comando:
git log --after="
" --before=" " --grep="Relnote" Confirma el recuento: Muéstrame el recuento total, los hashes y los títulos de todas las confirmaciones que identificaste. Te daré una confirmación para continuar.
Paso 4: Genera notas de la versión detalladas
Analiza cada confirmación: Para cada una de las confirmaciones que identificaste en el paso anterior, realiza un análisis detallado que incluya lo siguiente:
- Leer el mensaje de confirmación completo
- Examina la diferencia de código (git show
) para comprender el cambio. - Seguir los errores vinculados (por ejemplo, Error: 12345678) para obtener más contexto
Confirma conmigo antes de continuar.
Analiza los documentos relacionados en la carpeta docs para obtener información relacionada con las confirmaciones. Usa esta información para crear una nota de la versión con mucho contenido.
Antes de continuar, infórmame qué confirmaciones tienen información relacionada en la carpeta de documentos.
Obtiene los errores a los que se hace referencia en las confirmaciones. Usa la información del error para crear la nota de la versión de la confirmación.
Escribe la nota de la versión: Para cada confirmación, escribe una nota de la versión que incluya lo siguiente:
Referencia de confirmación: Antecede cada nota de la versión con un comentario de Markdown que contenga el hash de confirmación de la fuente, de la siguiente manera: .
Un título claro: Un resumen conciso en formato de oración del cambio.
Una explicación detallada: Un párrafo que explica de qué se trata el cambio.
Puntos clave sobre el cambio en el siguiente orden:
a. Por qué: Qué cambió y por qué cambió b. Impacto: El impacto en los desarrolladores de apps c. Migración: Ruta de migración (si corresponde)
Ejemplos de código "antes" y "después": Si la confirmación involucra un cambio de código visible para el usuario (por ejemplo, cambios en el DSL en archivos .gradle o modificaciones en la API), proporciona fragmentos de código claros y concisos que demuestren el cambio.
Sigue el estilo de las notas de la versión en https://developer.android.com/studio/releases.
Paso 5: Escribe las notas de la versión en un archivo Markdown
- Crea un archivo Markdown llamado release-notes-AAAA-MM-DDTHH:MM.md en la raíz del proyecto, donde, en formato ISO 8601, AAAA-MM-DD (año-mes-día) es la fecha actual, T es un separador y HH:MM (horas:minutos en formato de 24 horas) es la hora actual.
- Escribe una introducción que explique el propósito de las notas de la versión.
- Escribe un resumen de las notas de la versión.
- Escribe las notas de la versión completas y con formato.
Paso 6: Crea una confirmación
Crea una confirmación de Fig para el archivo de notas de la versión. No incluyas un ID de error.
Paso 7: Crea una lista de cambios
Crea un CL de la confirmación.