mpycz

mpycz

Descripción

Este proyecto está diseñado para refactorizar los archivos CHANGELOG.md generados utilizando la librería Commitizen. Simplifica el proceso de actualización de versiones, genera un changelog con un formato más estándar y automatiza tareas clave como subir cambios a GitHub.

Requisitos

• Python: Debes tener instalado Python en la versión 3.10.x o superior.
• Configuración de GitHub: Asegúrate de que tu usuario de GitHub esté configurado correctamente en la terminal de Git Bash.

Instalación

• Instala el paquete a través de npm:

  npm install -g mpycz
  

• Verifica que el comando mpbump esté disponible:

  mpbump --version
  

Uso

Comando principal

El comando principal es:

mpbump

Este comando realiza las siguientes acciones:

• Actualización de versión: Ejecuta internamente el comando cz bump, que incrementa la versión del proyecto de manera automática (por ejemplo, de 1.0.2 a 1.0.3) y genera un changelog con los últimos cambios.

• Refactorización del CHANGELOG.md: Un script interno de Python ajusta el formato del archivo CHANGELOG.md para hacerlo más estándar y agrega:

  • El nombre del usuario que realizó el commit.

• Push automático: Hace un push automático de los cambios a la rama de origen en GitHub.

Opciones adicionales

Evitar el push automático

Si deseas evitar que los cambios se suban automáticamente a GitHub, puedes usar la bandera --noPush:

mpbump --noPush

Esto ejecutará el resto de las acciones sin hacer el push al repositorio remoto.

Consideraciones

• Archivo CHANGELOG.md inicial: Antes de usar mpbump por primera vez, debes haber generado al menos un archivo CHANGELOG.md usando el comando original cz bump de Commitizen. Una vez hecho esto, ya no será necesario volver a usar dicho comando.

• No reemplaza comandos de Git: Este paquete no sustituye los comandos:

  • git add .
  • cz commit

  Por lo tanto, asegúrate de ejecutar esos comandos antes de usar mpbump.

Ejemplo de uso

git add .
cz commit
mpbump