--- name: update-plugin-docs description: Guía y procedimiento estándar para actualizar la documentación de un plugin UCRM (manifest.json, CHANGELOG.md, README.md), empaquetar la versión ZIP y publicar en GitHub. Úsalo cuando el usuario solicite "actualizar la documentación", "actualizar docs", "empaquetar plugin" o "crear nueva versión del plugin". --- # Procedimiento Estándar de Actualización de Documentación y Publicación de Plugins Este documento define la metodología obligatoria que debe seguirse cada vez que el usuario solicite **actualizar la documentación** de un plugin de UISP UCRM. ## 📋 Archivos a Actualizar (Obligatorio) Cuando se actualice la versión o documentación de un plugin, se deben modificar obligatoriamente los tres archivos siguientes: ### 1. `manifest.json` - Incrementar el número de versión en `"information": { "version": "X.Y.Z" }`. - Si el manifiesto incluye un arreglo `"changelog"`, añadir el nuevo objeto de versión con la fecha actual y la descripción del cambio. ### 2. `CHANGELOG.md` - Añadir la nueva entrada en la parte superior bajo la sección `## Changelog`: ```markdown ## [X.Y.Z] - YYYY-MM-DD ### Corregido / Mejorado / Agregado - **Módulo / Funcionalidad**: Descripción clara del cambio realizado. ``` ### 3. `README.md` - Actualizar el badge de versión al inicio del documento: `![Versión](https://img.shields.io/badge/version-X.Y.Z-blue.svg?style=for-the-badge)` - Añadir la versión y los aspectos destacados en la sección de novedades/historial de cambios recientes. --- ## 📦 Empaquetado de la Versión (.zip) Una vez actualizados `manifest.json`, `CHANGELOG.md` y `README.md`: 1. Ejecutar el script de empaquetado versionado desde la raíz del plugin: ```bash ./pack-plugin-versioned.php ``` 2. Confirmar que se haya generado el archivo ZIP con el nombre exacto de la versión: `{nombre-plugin}-{version}.zip`. --- ## 🐙 Publicación en Git (Commit & Push) 1. Agregar los archivos modificados: ```bash git add manifest.json CHANGELOG.md README.md public.php vendor/composer/installed.php ``` 2. Realizar el commit especificando la versión: ```bash git commit -m "docs: bump version X.Y.Z & update documentation" ``` 3. Enviar los cambios al repositorio remoto: ```bash git push ```