From 774b6e89a9376c8e1b507b471b115eaca2835ce9 Mon Sep 17 00:00:00 2001 From: DANYDHSV Date: Sun, 2 Aug 2026 12:18:51 -0600 Subject: [PATCH] docs: update README.md version & add update-plugin-docs skill --- .agent/skills/update-plugin-docs/SKILL.md | 58 +++++++++++++++++++++++ README.md | 6 ++- 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 .agent/skills/update-plugin-docs/SKILL.md diff --git a/.agent/skills/update-plugin-docs/SKILL.md b/.agent/skills/update-plugin-docs/SKILL.md new file mode 100644 index 00000000..e2cde13e --- /dev/null +++ b/.agent/skills/update-plugin-docs/SKILL.md @@ -0,0 +1,58 @@ +--- +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 + ``` diff --git a/README.md b/README.md index a902930e..56c9d1fc 100755 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # SIIP - WhatsApp Notifications & Integrated Payment Portal -![Version](https://img.shields.io/badge/version-4.7.4-blue.svg?style=for-the-badge) +![Version](https://img.shields.io/badge/version-4.7.5-blue.svg?style=for-the-badge) ![UCRM Compatibility](https://img.shields.io/badge/UCRM-v2.1.0%2B-green.svg?style=for-the-badge) ![Status](https://img.shields.io/badge/status-PRODUCTION-success.svg?style=for-the-badge) ![Author](https://img.shields.io/badge/author-SIIP_INTERNET-orange.svg?style=for-the-badge) Este plugin es una solución integral que transforma tu UCRM en un **Portal Administrativo de Última Generación**. No solo automatiza la comunicación por WhatsApp, sino que integra un Dashboard completo para la gestión de pagos online (Stripe/OXXO), visualización de comprobantes y coordinación de equipos técnicos. +## ✨ Novedades v4.7.5 (Embedded Mode Integration) + +- **🖼️ Modo Embebido en Portal Unificado**: Soporte completo para renderizado transparente dentro del iframe de `siip-cashier-tools-ui` (`embedded=1`), ocultando la cabecera y el menú principal para evitar duplicidades visuales. + ## ✨ Novedades v4.7.4 (Offline CPE Password Preservation Hotfix) - **🔑 Preservación de Clave de Antena Desconectada**: Se añadió una capa de validación que detecta si el CPE del cliente en UISP está fuera de línea. Si ya existía una contraseña válida en UCRM, el script evita sobrescribirla con la leyenda de error por desconexión. Esto preserva la credencial de acceso para que los instaladores puedan conectarse físicamente al equipo y alinearlo o repararlo en sitio.