Skip to content

Fix unstable changelog overview file #7124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
BlackYps wants to merge 2 commits into
base: develop
Choose a base branch
from
+96 −95
Draft

Fix unstable changelog overview file #7124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cd51cd
Fix unstable patch order
BlackYps May 16, 2026
57722b3
Update lobby changelogs
FAForeverBot May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/workflows/scripts/python/changelog_overview.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ def process_markdown_file(markdown_file: Path) -> Optional[Tuple[str, date]]:
URL = "http://faforever.github.io/fa/changelog/{url}",
Path = "/lua/ui/lobby/changelog/generated/{markdown_file.stem}.lua"
}},"""
return entry, parsed_date
return entry, parsed_date, int(version)

except Exception as e:
raise RuntimeError(f"Failed to process {markdown_file.name}") from e

def create_overview_file(input_dir: Path, output_file: Path):
"""Creates an overview Lua file listing all changelogs with metadata."""
entries: list[Tuple[str, date]] = []
entries: list[Tuple[str, date, int]] = []

logging.info(f"Scanning directory: {input_dir}")
for markdown_file in input_dir.glob("*.md"):
Expand All @@ -91,15 +91,16 @@ def create_overview_file(input_dir: Path, output_file: Path):
logging.warning("No valid changelog entries found.")
return

entries.sort(key=lambda pair: pair[1], reverse=True)
# Sort by date and then by version
entries.sort(key=lambda pair: (pair[1], pair[2]), reverse=True)

logging.info("Generating overview Lua content...")
overview_content = OVERVIEW_HEADER + """
---@type UIChangelogOverview
Overview = {
Changelogs = {
"""
overview_content += "\n".join(entry for entry, _ in entries)
overview_content += "\n".join(entry for entry, _, _ in entries)
overview_content += "\n }\n}\n"

output_file.write_text(overview_content)
Expand Down
182 changes: 91 additions & 91 deletions lua/ui/lobby/changelog/generated/overview.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3834",
Path = "/lua/ui/lobby/changelog/generated/2026-04-06-3834.lua"
},
{
Version = 3832,
Name = "3832 - Hotfix",
Date = "2026-04-01",
URL = "http://faforever.github.io/fa/changelog/3832",
Path = "/lua/ui/lobby/changelog/generated/2026-04-01-3832.lua"
},
{
Version = 3833,
Name = "3833 - Hotfix",
Date = "2026-04-01",
URL = "http://faforever.github.io/fa/changelog/3833",
Path = "/lua/ui/lobby/changelog/generated/2026-04-01-3833.lua"
},
{
Version = 3832,
Name = "3832 - Hotfix",
Date = "2026-04-01",
URL = "http://faforever.github.io/fa/changelog/3832",
Path = "/lua/ui/lobby/changelog/generated/2026-04-01-3832.lua"
},
{
Version = 3831,
Name = "3831 - Hotfix",
Expand Down Expand Up @@ -152,13 +152,6 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3816",
Path = "/lua/ui/lobby/changelog/generated/2024-12-10-3816.lua"
},
{
Version = 3813,
Name = "3813 - Game Patch",
Date = "2024-11-29",
URL = "http://faforever.github.io/fa/changelog/3813",
Path = "/lua/ui/lobby/changelog/generated/2024-11-29-3813.lua"
},
{
Version = 3815,
Name = "3815 - Hotfix",
Expand All @@ -173,6 +166,13 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3814",
Path = "/lua/ui/lobby/changelog/generated/2024-11-29-3814.lua"
},
{
Version = 3813,
Name = "3813 - Game Patch",
Date = "2024-11-29",
URL = "http://faforever.github.io/fa/changelog/3813",
Path = "/lua/ui/lobby/changelog/generated/2024-11-29-3813.lua"
},
{
Version = 3812,
Name = "3812 - Hotfix",
Expand Down Expand Up @@ -222,20 +222,20 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3806",
Path = "/lua/ui/lobby/changelog/generated/2024-03-31-3806.lua"
},
{
Version = 3804,
Name = "3804 - Hotfix",
Date = "2024-03-24",
URL = "http://faforever.github.io/fa/changelog/3804",
Path = "/lua/ui/lobby/changelog/generated/2024-03-24-3804.lua"
},
{
Version = 3805,
Name = "3805 - Hotfix",
Date = "2024-03-24",
URL = "http://faforever.github.io/fa/changelog/3805",
Path = "/lua/ui/lobby/changelog/generated/2024-03-24-3805.lua"
},
{
Version = 3804,
Name = "3804 - Hotfix",
Date = "2024-03-24",
URL = "http://faforever.github.io/fa/changelog/3804",
Path = "/lua/ui/lobby/changelog/generated/2024-03-24-3804.lua"
},
{
Version = 3803,
Name = "3803 - Hotfix",
Expand All @@ -257,20 +257,20 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3801",
Path = "/lua/ui/lobby/changelog/generated/2024-03-16-3801.lua"
},
{
Version = 3780,
Name = "3780 - Hotfix",
Date = "2024-01-26",
URL = "http://faforever.github.io/fa/changelog/3780",
Path = "/lua/ui/lobby/changelog/generated/2024-01-26-3780.lua"
},
{
Version = 3781,
Name = "3781 - Hotfix",
Date = "2024-01-26",
URL = "http://faforever.github.io/fa/changelog/3781",
Path = "/lua/ui/lobby/changelog/generated/2024-01-26-3781.lua"
},
{
Version = 3780,
Name = "3780 - Hotfix",
Date = "2024-01-26",
URL = "http://faforever.github.io/fa/changelog/3780",
Path = "/lua/ui/lobby/changelog/generated/2024-01-26-3780.lua"
},
{
Version = 3779,
Name = "3779 - Game Patch",
Expand Down Expand Up @@ -439,13 +439,6 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3754",
Path = "/lua/ui/lobby/changelog/generated/2023-03-05-3754.lua"
},
{
Version = 3751,
Name = "3751 - Game Patch",
Date = "2023-02-25",
URL = "http://faforever.github.io/fa/changelog/3751",
Path = "/lua/ui/lobby/changelog/generated/2023-02-25-3751.lua"
},
{
Version = 3753,
Name = "3753 - Hotfix",
Expand All @@ -460,6 +453,13 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3752",
Path = "/lua/ui/lobby/changelog/generated/2023-02-25-3752.lua"
},
{
Version = 3751,
Name = "3751 - Game Patch",
Date = "2023-02-25",
URL = "http://faforever.github.io/fa/changelog/3751",
Path = "/lua/ui/lobby/changelog/generated/2023-02-25-3751.lua"
},
{
Version = 3750,
Name = "3750 - Game Patch",
Expand Down Expand Up @@ -488,20 +488,20 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3747",
Path = "/lua/ui/lobby/changelog/generated/2022-11-15-3747.lua"
},
{
Version = 3745,
Name = "3745 - Game Patch",
Date = "2022-11-06",
URL = "http://faforever.github.io/fa/changelog/3745",
Path = "/lua/ui/lobby/changelog/generated/2022-11-06-3745.lua"
},
{
Version = 3746,
Name = "3746 - Hotfix",
Date = "2022-11-06",
URL = "http://faforever.github.io/fa/changelog/3746",
Path = "/lua/ui/lobby/changelog/generated/2022-11-06-3746.lua"
},
{
Version = 3745,
Name = "3745 - Game Patch",
Date = "2022-11-06",
URL = "http://faforever.github.io/fa/changelog/3745",
Path = "/lua/ui/lobby/changelog/generated/2022-11-06-3745.lua"
},
{
Version = 3744,
Name = "3744 - Hotfix",
Expand Down Expand Up @@ -572,6 +572,13 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3735",
Path = "/lua/ui/lobby/changelog/generated/2022-04-24-3735.lua"
},
{
Version = 3734,
Name = "3734 - Hotfix",
Date = "2022-04-22",
URL = "http://faforever.github.io/fa/changelog/3734",
Path = "/lua/ui/lobby/changelog/generated/2022-04-22-3734.lua"
},
{
Version = 3733,
Name = "3733 - Hotfix",
Expand All @@ -586,13 +593,6 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3732",
Path = "/lua/ui/lobby/changelog/generated/2022-04-22-3732.lua"
},
{
Version = 3734,
Name = "3734 - Hotfix",
Date = "2022-04-22",
URL = "http://faforever.github.io/fa/changelog/3734",
Path = "/lua/ui/lobby/changelog/generated/2022-04-22-3734.lua"
},
{
Version = 3731,
Name = "3731 - Hotfix",
Expand All @@ -607,62 +607,62 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3730",
Path = "/lua/ui/lobby/changelog/generated/2021-12-23-3730.lua"
},
{
Version = 3728,
Name = "3728 - Game Patch",
Date = "2021-12-20",
URL = "http://faforever.github.io/fa/changelog/3728",
Path = "/lua/ui/lobby/changelog/generated/2021-12-20-3728.lua"
},
{
Version = 3729,
Name = "3729 - Hotfix",
Date = "2021-12-20",
URL = "http://faforever.github.io/fa/changelog/3729",
Path = "/lua/ui/lobby/changelog/generated/2021-12-20-3729.lua"
},
{
Version = 3728,
Name = "3728 - Game Patch",
Date = "2021-12-20",
URL = "http://faforever.github.io/fa/changelog/3728",
Path = "/lua/ui/lobby/changelog/generated/2021-12-20-3728.lua"
},
{
Version = 3727,
Name = "3727 - Hotfix",
Date = "2021-11-26",
URL = "http://faforever.github.io/fa/changelog/3727",
Path = "/lua/ui/lobby/changelog/generated/2021-11-26-3727.lua"
},
{
Version = 3725,
Name = "3725 - Game Patch",
Date = "2021-11-26",
URL = "http://faforever.github.io/fa/changelog/3725",
Path = "/lua/ui/lobby/changelog/generated/2021-11-26-3725.lua"
},
{
Version = 3726,
Name = "3726 - Hotfix",
Date = "2021-11-26",
URL = "http://faforever.github.io/fa/changelog/3726",
Path = "/lua/ui/lobby/changelog/generated/2021-11-26-3726.lua"
},
{
Version = 3725,
Name = "3725 - Game Patch",
Date = "2021-11-26",
URL = "http://faforever.github.io/fa/changelog/3725",
Path = "/lua/ui/lobby/changelog/generated/2021-11-26-3725.lua"
},
{
Version = 3724,
Name = "3724 - Game Patch",
Date = "2021-10-04",
URL = "http://faforever.github.io/fa/changelog/3724",
Path = "/lua/ui/lobby/changelog/generated/2021-10-04-3724.lua"
},
{
Version = 3722,
Name = "3722 - Hotfix",
Date = "2021-09-19",
URL = "http://faforever.github.io/fa/changelog/3722",
Path = "/lua/ui/lobby/changelog/generated/2021-09-19-3722.lua"
},
{
Version = 3723,
Name = "3723 - Hotfix",
Date = "2021-09-19",
URL = "http://faforever.github.io/fa/changelog/3723",
Path = "/lua/ui/lobby/changelog/generated/2021-09-19-3723.lua"
},
{
Version = 3722,
Name = "3722 - Hotfix",
Date = "2021-09-19",
URL = "http://faforever.github.io/fa/changelog/3722",
Path = "/lua/ui/lobby/changelog/generated/2021-09-19-3722.lua"
},
{
Version = 3721,
Name = "3721 - Game Patch",
Expand Down Expand Up @@ -698,20 +698,20 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3717",
Path = "/lua/ui/lobby/changelog/generated/2020-09-13-3717.lua"
},
{
Version = 3715,
Name = "3715 - Game Patch",
Date = "2020-09-12",
URL = "http://faforever.github.io/fa/changelog/3715",
Path = "/lua/ui/lobby/changelog/generated/2020-09-12-3715.lua"
},
{
Version = 3716,
Name = "3716 - Hotfix",
Date = "2020-09-12",
URL = "http://faforever.github.io/fa/changelog/3716",
Path = "/lua/ui/lobby/changelog/generated/2020-09-12-3716.lua"
},
{
Version = 3715,
Name = "3715 - Game Patch",
Date = "2020-09-12",
URL = "http://faforever.github.io/fa/changelog/3715",
Path = "/lua/ui/lobby/changelog/generated/2020-09-12-3715.lua"
},
{
Version = 3714,
Name = "3714 - Game Patch",
Expand Down Expand Up @@ -761,20 +761,20 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3708",
Path = "/lua/ui/lobby/changelog/generated/2019-10-19-3708.lua"
},
{
Version = 3706,
Name = "3706 - Hotfix",
Date = "2019-07-14",
URL = "http://faforever.github.io/fa/changelog/3706",
Path = "/lua/ui/lobby/changelog/generated/2019-07-14-3706.lua"
},
{
Version = 3707,
Name = "3707 - Hotfix",
Date = "2019-07-14",
URL = "http://faforever.github.io/fa/changelog/3707",
Path = "/lua/ui/lobby/changelog/generated/2019-07-14-3707.lua"
},
{
Version = 3706,
Name = "3706 - Hotfix",
Date = "2019-07-14",
URL = "http://faforever.github.io/fa/changelog/3706",
Path = "/lua/ui/lobby/changelog/generated/2019-07-14-3706.lua"
},
{
Version = 3705,
Name = "3705 - Game Patch",
Expand Down Expand Up @@ -971,6 +971,13 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3671",
Path = "/lua/ui/lobby/changelog/generated/2017-01-19-3671.lua"
},
{
Version = 3670,
Name = "3670 - Hotfix",
Date = "2017-01-17",
URL = "http://faforever.github.io/fa/changelog/3670",
Path = "/lua/ui/lobby/changelog/generated/2017-01-17-3670.lua"
},
{
Version = 3669,
Name = "3669 - Hotfix",
Expand All @@ -985,13 +992,6 @@ Overview = {
URL = "http://faforever.github.io/fa/changelog/3668",
Path = "/lua/ui/lobby/changelog/generated/2017-01-17-3668.lua"
},
{
Version = 3670,
Name = "3670 - Hotfix",
Date = "2017-01-17",
URL = "http://faforever.github.io/fa/changelog/3670",
Path = "/lua/ui/lobby/changelog/generated/2017-01-17-3670.lua"
},
{
Version = 3667,
Name = "3667 - Hotfix",
Expand Down
Loading