FAForever
Automatic deployment of in-game changelogs
Description
This is the first in a series of issues to improve the status quo of how we work with changelogs in-game.
The journey related to changelogs started in 2024. This happened in several steps:
- https://github.com/FAForever/fa/pull/5721
The first step where we separated the previously massive changelog file into separate files. This made the changelogs more manageable.
- https://github.com/FAForever/fa/pull/6231
The introduction of changelog snippets. This change allows contributors to write a snippet in the changelog snippets folder which provides a description of the changes that members of the community can read more easily. The snippets are combined by a workflow, which generates a typical changelog file. This file can then be used when a release happens.
The next step in the process is to put the generated changelogs on the general wiki. An example is already available:
- https://wiki.faforever.com/en/generated/changelog/3801
During the game team meeting of 08/06/2024 @lL1l1 also suggested to use a similar process to get the changelogs into the game again. This would include the generated changelog. This allows us to (among others) lazy load the changelog files in Lua. And we can generate the changelog files based on the existing changelog files in (https://github.com/FAForever/fa/tree/develop/changelog). And last but not least, generate the 'open changes' changelog file by using the changelog snippets folder.
Course of action
There are several steps to undertake in this journey:
Lua related issues:
- https://github.com/FAForever/fa/issues/6239
- https://github.com/FAForever/fa/issues/6241
Github Actions (Automation) related issues:
- https://github.com/FAForever/fa/issues/6238
- https://github.com/FAForever/fa/issues/6237
- https://github.com/FAForever/fa/issues/6240
- https://github.com/FAForever/fa/issues/6242 (Wraps up everything)
