Release Notes and Changelogs

Description, Purpose and Objective

NOTE

The Release Notes (or Changelogs) view is the official communication channel within the platform that details updates, improvements, bug fixes and new functionalities implemented in the system.

A Changelog (or Change Log) is a structured document that chronologically compiles the modifications made to a specific version of the software. It is classified by Category (which corresponds to the platform product affected by the update, for example, PEEC or Quattrol 365) and indicates the Version number of the system.

The objective of this view is to keep users and administrators informed about the technical evolution of the platform, guaranteeing visibility of the optimizations and new tools made available to your organization.

---

Context of Use

This module is used by:

• Super Administrators: To record and publish detailed release notes when updates are released to production.
• General Users: To consult the history of improvements implemented in your product and understand how the new features of the platform work.

---

Possible Actions

1. View and Search Release Notes

Allows all users to view the general table of updates published in the system, which details:

• Name: Administrative identifier of the change (e.g. Update Auth Flow).
• Title: Public header visible to the user (e.g. Mejoras en el inicio de sesión).
• Category: Specific product affected by the update.
• Description: Narrative detail of the included optimizations or corrections.
• Version: Build version number code.
• Registration Date: Day the release note was published.

The top search bar lets you enter keywords (such as a product, version number, or concept) to instantly filter table rows.

[Illustrative image: Release Notes List]

2. Add a New Release Note

To publish a system update:

1. Click the "Add changelog" button at the top right of the table.
2. Complete the information requested in the side form:
   • Name: Technical name of the change.
   • Title: Explanatory title that users will see.
   • Category: Select the product from the autocomplete list.
   • Version: Enter the version number.
   • Description: Write exhaustively the list of changes made.
3. Click "Add" to publish the note.

[Illustrative image: Add Release Notes Form]

3. Edit a Release Note

If you need to correct the wording or update the data of an existing release note:

1. Click "Edit" (pencil icon ✏️) in the corresponding row.
2. The side form will open with the data pre-filled. Make the necessary changes.
3. Click "Update" to apply the changes immediately to the users' display.

[Illustrative image: Edit Release Notes Form]

4. Delete a Release Note

To delete a post from history:

1. Click "Delete" (trash icon 🗑️) in the action column of the release note.
2. Confirm the action in the security popup modal.

WARNING

Deleting a release note is permanent and irreversible in the system database.

[Illustrative image: Delete Release Note Confirmation Modal]

5. Export Release Notes

Allows you to download the complete history of released release notes in .CSV format by clicking the download icon at the top right of the table.

[Illustrative image: Release Notes Export]

---

Required Technical Permits

Access to this module is controlled by the following permissions in the user's role profile:

• changelog_read: Allows access to view and read the release notes table.
• changelog_create: Enables the action of adding new release notes.
• changelog_update: Allows you to edit and update the content of already published notes.
• changelog_delete: Authorizes deletion of records from the release notes database.
• changelog_export: Enables downloading changelog data in .CSV format.