Notas de Versión y Changelogs
Descripción, Propósito y Objetivo
NOTE
La vista de Notas de Versión (o Changelogs) es el canal oficial de comunicación dentro de la plataforma que detalla las actualizaciones, mejoras, correcciones de errores y nuevas funcionalidades implementadas en el sistema.
Un Changelog (o Registro de Cambios) es un documento estructurado que recopila cronológicamente las modificaciones realizadas en una versión específica del software. Se clasifica por Categoría (que corresponde al producto de la plataforma afectado por la actualización, por ejemplo, PEEC o Quattrol 365) e indica el número de Versión del sistema.
El objetivo de esta vista es mantener informados a los usuarios y administradores sobre la evolución técnica de la plataforma, garantizando la visibilidad de las optimizaciones y nuevas herramientas puestas a disposición de su organización.
Contexto de Uso
Este módulo es utilizado por:
- Super Administradores: Para registrar y publicar notas de versión detalladas cuando se liberan actualizaciones en producción.
- Usuarios Generales: Para consultar el historial de mejoras implementadas en su producto y entender el funcionamiento de las nuevas características de la plataforma.
Acciones Posibles
1. Consultar y Buscar Notas de Versión
Permite a todos los usuarios visualizar la tabla general de actualizaciones publicadas en el sistema, la cual detalla:
- Nombre: Identificador administrativo del cambio (ej.
Update Auth Flow). - Título: Encabezado público visible para el usuario (ej.
Mejoras en el inicio de sesión). - Categoría: Producto específico afectado por la actualización.
- Descripción: Detalle narrativo de las optimizaciones o correcciones incluidas.
- Versión: Código numérico de versión de la compilación.
- Fecha de Registro: Día en que se publicó la nota de versión.
La barra de búsqueda superior permite escribir palabras clave (como un producto, un número de versión o un concepto) para filtrar las filas de la tabla de forma instantánea.
[Imagen ilustrativa: Listado de Notas de Versión]
2. Agregar una Nueva Nota de Versión
Para publicar una actualización del sistema:
- Haga clic en el botón "Agregar changelog" en la parte superior derecha de la tabla.
- Complete la información solicitada en el formulario lateral:
- Nombre: Nombre técnico del cambio.
- Título: Título explicativo que verán los usuarios.
- Categoría: Seleccione el producto de la lista autocompletable.
- Versión: Escriba el número de la versión.
- Descripción: Redacte de forma exhaustiva el listado de cambios realizados.
- Haga clic en "Agregar" para publicar la nota.
[Imagen ilustrativa: Formulario Agregar Notas de Versión]
3. Editar una Nota de Versión
Si requiere corregir la redacción o actualizar los datos de una nota de versión existente:
- Haga clic en "Editar" (icono de lápiz ✏️) en la fila correspondiente.
- El formulario lateral se abrirá con los datos precargados. Realice los cambios necesarios.
- Haga clic en "Actualizar" para aplicar los cambios de inmediato en la visualización de los usuarios.
[Imagen ilustrativa: Formulario Editar Notas de Versión]
4. Borrar una Nota de Versión
Para eliminar una publicación del historial:
- Haga clic en "Borrar" (icono de papelera 🗑️) en la columna de acciones de la nota de versión.
- Confirme la acción en el modal emergente de seguridad.
WARNING
La eliminación de una nota de versión es permanente e irreversible en la base de datos del sistema.
[Imagen ilustrativa: Modal Confirmación de Eliminación de Nota de Versión]
5. Exportar Notas de Versión
Permite descargar el historial completo de notas de versión publicadas en formato .CSV haciendo clic en el icono de descarga superior derecho de la tabla.
[Imagen ilustrativa: Exportación de Notas de Versión]
Permisos Técnicos Requeridos
El acceso a este módulo está controlado por los siguientes permisos en el perfil de rol del usuario:
changelog_read: Permite el acceso a la vista y lectura de la tabla de notas de versión.changelog_create: Habilita la acción de agregar nuevas notas de versión.changelog_update: Permite editar y actualizar el contenido de las notas ya publicadas.changelog_delete: Autoriza el borrado de registros de la base de datos de notas de versión.changelog_export: Habilita la descarga de los datos de changelogs en formato.CSV.