How are Changelogs generated

LightAct Changelogs are generated semi-automatically from LightAct 4 Jira project.

Organisation of tickets

Ticket is a generic term referring to a work item or a task in Jira.

Epics

Our Development tickets are organized in Epics. Epics are a collection of tasks, for example:

• Flexible asset management for big shows

• Robust LightSync for 4.13

• Better timeline programming

• etc.

Our changelogs list all the Epics and in the Epics all the tickets that are part of it. At the end, it lists tickets that were not part of any Epic.

Features, Improvements and Fixes

Tickets are categorized into 3 different types:

• Features: completely new functionalities

• Improvements: improved existing functionalities

• Fixes: fixes of existing functionalities

Ticket data

Ticket description

We use AI to convert a description of the ticket that's designed for development into something that, hopefully, is readable by you, our users.

For example, below is a description written by a human for a developer:

"Can we add a simple node that triggers once when LightAct closes? Its name would be Run on Shutdown.

The search keywords would also be: close, exit"

AI then transforms this into the following description for the changelog:

Introducing "Run on Shutdown", a simple node that triggers once when LightAct closes. Keywords: close, exit.

As always with AI, sometimes it works great, but sometimes it's less than ideal.

Additional Data

In the changelog we also show 2 additional pieces of information:

• Status: status of the tickets. If the release is a Beta release, some tickets might have a Testing status

• Requesters: we list 3 letter acronyms of the users that requested a specific upgrade. If no Requesters are listed, it means the ticket was designed by us.

What's included in the Changelog

Not all tickets are included in the Changelog, but only those we deem to be of interest to our users.