Publicar y mantener un módulo¶
Publicar una extensión no termina al crear el ZIP. El cliente necesita saber qué instala, qué datos utiliza y cómo evolucionará.
Checklist de publicación¶
- El
manifest.jsones válido y declara solo superficies necesarias. - El paquete tiene una única raíz y no contiene secretos ni archivos de desarrollo.
- Las vistas funcionan en carga directa y actualización parcial.
- Cada acción comprueba método, autenticación, permiso y datos.
- Los endpoints públicos tienen autenticación, límites e idempotencia.
- La instalación y desinstalación están documentadas.
- Los ejemplos usan datos ficticios.
- El README explica requisitos, permisos, datos y soporte.
-
CHANGELOG.mdrecoge cambios incompatibles y correcciones de seguridad.
Versionado¶
Usa SemVer:
- MAJOR: cambio incompatible en vistas, acciones, permisos o datos.
- MINOR: nueva capacidad compatible.
- PATCH: corrección compatible.
No reutilices una versión para dos paquetes distintos. Si una actualización requiere intervención, descríbela antes de aplicarla.
Documentación para el cliente¶
Incluye una página con:
- objetivo del módulo;
- requisitos y servicios externos;
- permisos que solicita;
- configuración inicial;
- flujo de trabajo recomendado;
- datos que crea, conserva o elimina;
- límites conocidos y contacto de soporte.
La instalación y publicación final deben seguir el canal autorizado para el tenant o catálogo correspondiente. No compartas credenciales de distribución en el paquete ni en la documentación.