Component: Application Changelog

Introduction

The Application changelog component allows the administrator to manage the changelogs of an application's projects. It reduces the difficulty of version management and makes project changes easy to trace back.

Features

Projects

This section describes how to manage projects.

The administrator can handle the changes and versions of multiple projects. To view and manage projects, go to the Projects page. Below is a screenshot of the page.

Project List

On the page, you can see a list of all created projects with almost all of their information:

• Name: The name of the project
• Version: The latest version of the project
• Last changed: The timestamp when the latest change was made
• Start date: The date the project starts
• Created by: The name of the user who created the project

Add or Edit a Project

Above the list, you can find the Add and Edit buttons.

Clicking either button opens the Add Or Edit Project dialog. Here is a screenshot of the dialog:

On this dialog, you can enter the information of the project that you are working on:

• Name [required]: You must enter a representative name for the project. The project's name must be unique.
• Version [optional]: You can enter a version for the project. Otherwise, the component will fill in an initial version of 1.0.0.
• Description [optional]: You can write anything you want in this field to describe the project.
• Start date [optional]: You can enter the date the project starts.

Delete a Project

To delete a project, select it in the list and click the Delete button.

A dialog is shown to ask for confirmation. If you want to proceed, select Yes; otherwise, click the No button.

Changelogs

This section shows you how to manage changelogs.

To work with changelogs, go to the Changelogs page. Below is a screenshot of the page.

Changelog List

All changelogs are listed with the following information:

• Timestamp: The timestamp when the change takes effect on the project
• Project: The name of the project to which the change belongs
• Version: The version shipped with the changelog
• Created by: The name of the user who created the changelog

Add or Edit a Changelog

In the same manner as on the Projects page, the Add and Edit buttons are also located above the list.

The Add Or Edit Changelog dialog appears when either button is clicked. Here is a screenshot of the dialog:

Here is the information that you can enter on the dialog:

• Project [required]: You must select the project to which the changelog belongs. The projects in the list are the created projects. If you cannot find the desired project, you can click the Add button to add a new project.
• Timestamp [required]: This input is initialized with the current time.
• Version [optional]: You can enter a version, or the component will fill in an initial version of 1.0.0.
• Changelog [required]: The content of the changelog. The component shows a toolbox to format the content.

When a changelog is saved, the component automatically updates the version and the last-changed timestamp of the related project.

View Changelog Details

If you just want to view the details of a specific changelog, you can click the version text of a changelog.

Here is the dialog that displays the details of a changelog:

Delete a Changelog

Select a changelog in the list and click the Delete button.

A dialog is shown to ask for confirmation. If you want to proceed, select Yes; otherwise, click the No button.

Integration - Use The Information On An Application

The component exposes a web trigger that allows retrieving the information of a specific project. Here are the details of the web trigger:

• URL: [Casewhere API URL]/external/v0.1/trigger/cw-chlog-get-project-information
• Method: GET
• Parameters:
  • project_name: The name of the project you want to get. It is case-sensitive
  • fields: Fields that you expect the API to return. Fields are separated by a comma (should be encoded if needed). For example: name,version

Example:

curl "https://components-api-dev.casewhere.com/external/v0.1/trigger/cw-chlog-get-project-information?project_name=Project&fields=start_date,name"
Response: {"StartDate":"2022-06-08T22:00:00Z","Name":"Project"}

Moreover, the component provides two AngularJs components that allow developers to easily show the version on worker sites.

The first one only displays the version of a specific project:

<cw-chlog-project-version project-name="Project" />

The next one displays the version of the Casewhere platform and the version of a specific project:

<cw-chlog-product-version project-name="Project" />

The text from this AngularJs component follows the "<Casewhere version> - <Project version>" format. For example, 2.7.2 - 1.34.0

To use these AngularJs components, you must add your worker site to them by going to the Worker Site Components and editing the components as in the image below:

Please note that both AngularJs components are inline HTML elements.

Installation

Requirements

• Casewhere 2.6.0 or later.

Configuration

1. Import Casewhere Changelog product
2. Link the cw-chlog-projects, cw-chlog-changelogs and cw-chlog-changelog-details pages to your worker sites and configure access control
3. Configure projects
4. Configure changelogs

Dependencies

No dependencies required

Releases

1.0.0 - 10/06/2022

Changelog

• Projects manager
• Changelogs manager
• Project - changelogs synchronization
• A web trigger to get information of a specific project
• An AngularJs component to display the project's version

Download (login required): Casewhere Changelog v1.0.0