Tomorrow, em... Hoy en solo unas horas se llevará a cabo UI5Con 2018 en St. Leon-Rot, Alemania. Hace solo unas horas le prometí a
c3d1947136cd4c748a7aa794001af496
escribir este blog: En lugar de filtrar nuevas características de UI5, te mostraré lo fácil que es descubrir nuevas funciones usando solo unos pocos comandos. De hecho, lo que leerás se puede usar fácilmente para
crear/generar notas de lanzamiento para tus aplicaciones (es decir, para mostrarlas en la interfaz de usuario)
.
Este blog funciona para cualquier persona que use git en combinación con anotaciones en los mensajes de confirmación de git. Para seguir este blog, asegúrate de tener instalado git. Simplemente usaremos el repositorio público de OpenUI5 en GitHub, pero también funciona con cualquier otro repositorio git (usando los mensajes de confirmación correspondientes).
Vamos a utilizar comandos simples en lugar de usar una de las muchas herramientas disponibles... Y ten en cuenta que hay muchas opciones disponibles incluso al usar comandos git, las que se enumeran aquí son solo algunas de las opciones que tienes...
1. Suposiciones
Supongamos que has acordado en tu proyecto prefijar los mensajes de confirmación de git con uno o más de ciertos prefijos (no necesariamente para todos los cambios/confirmaciones):
Anotación
|
Descripción
|
Ejemplo
git commit
|
[INTERNAL]
|
utilizado para cosas internas
|
git commit -m "[INTERNAL] mi cambio interno"
|
[FIX]
|
contiene una corrección de errores
|
git commit -m "[FIX] mi cambio de corrección"
|
[FEATURE]
|
contiene una nueva característica
|
git commit -m "[FEATURE] mi nueva característica"
|
[DOC]
|
contiene documentación
|
git commit -m "[DOC] mi cambio de documentación"
|
Basándonos en las anotaciones anteriores, es bastante fácil generar una lista simple que contenga, por ejemplo, todas las características, o todas las características y correcciones de errores, etc. En escenarios más avanzados, también podrías generar archivos de un formato determinado, es decir, podrías generar archivos json que contengan las características, tal vez para mostrar estas características dentro del menú de ayuda de tu aplicación web
😉
Para mayor simplicidad, solo crearemos una lista simple. Cuando hablamos de notas de lanzamiento, es posible que queramos enumerar solo las características agregadas desde la última versión; algo que también queremos generar a partir de los mensajes de confirmación.
Qué coincidencia que OpenUI5 use tales anotaciones
🙂
2. Clonar un repositorio git que usa anotaciones en los mensajes de confirmación
Para esta demostración, usaré la biblioteca de JavaScript OpenUI5 de acceso público. Soy consciente de que utilizan anotaciones para sus mensajes de confirmación. Simplemente clona el repositorio y cambia a la carpeta creada:
git clone https://github.com/SAP/openui5.git
cd openui5
3. Mostrando registros de confirmación
Usar
git log
en tu CLI te permite ver los mensajes de confirmación:
git log
4. Formateando los registros