Changelog Generation | BandaStation

[m-dzianishchyts]

Что этот PR делает

Изменяет пути к чейнджлогам в системе ТГ. Кастомизирует окно чейнджлога.

По результатам бурного обсуждения в дисе стало ясно, что у системы чейнджлога есть 2 основные проблемы:

1. Изменение чейнджлога в индексированном архивном файле может приводить к конфликтам при мерже апстрима.
2. Изменение чейнджлога происходит с созданием дополнительного коммита.

Проблема 1 решается этим ПРом, поскольку чейнджлог лежит в поддиректории.
Проблема 2 может решиться наличием отдельной ветки и ленивыми HTTP запросами, но она мне не кажется существенной, особенно с учетом того, что коммиты ТГ уже переносятся в наш мастер как-есть и чейнджлог коммиты все равно останутся.

Тестирование

m-dzianishchyts@b15f7eb
m-dzianishchyts@9b6bb0b

Картинко

Summary by Sourcery

Update changelog paths and customize the changelog window.

New Features:

• Add a new changelog interface for BandaStation.

Build:

• Update changelog compilation path.

CI:

• Update CI workflows to use the new changelog path and always run the changelog generation job when a PR is merged.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request modifies the changelog system to store changelogs in a subdirectory, and customizes the changelog window.

Class diagram for the changelog system changes

classDiagram
    class ChangelogBandaStation {
        -data: string
        -selectedDate: string
        -selectedIndex: number
        -dateChoices: array
        +constructor()
        +setData(data)
        +setSelectedDate(date)
        +setSelectedIndex(index)
        +getData(date, attemptNumber)
        +componentDidMount()
        +render()
    }

    class changelog {
        +ui_interact(user, ui)
        +ui_static_data()
    }

    class changelog_item {
        +New(date)
        -item_filename: string
    }

    changelog --> ChangelogBandaStation: uses
    changelog_item --> ChangelogBandaStation: provides data

Loading

File-Level Changes

Change	Details	Files
Move changelog files to a subdirectory.	Modified the github workflow to compile changelogs to the new subdirectory. Modified the check changelogs script to point to the new subdirectory. Modified the make changelog script to point to the new subdirectory. Modified the auto changelog script to point to the new subdirectory. Modified the changelog item to point to the new subdirectory.	.github/workflows/compile_changelogs.yml tools/ci/check_changelogs.sh tools/makeChangelog.bat tools/pull_request_hooks/autoChangelog.js modular_bandastation/changelog/code/changelog_item.dm
Customize the changelog window.	Added a new React component for the BandaStation changelog window. Added a new UI interaction for the changelog. Added a new modpack for the changelog.	tgui/packages/tgui/interfaces/ChangelogBandaStation.jsx modular_bandastation/changelog/code/changelog.dm modular_bandastation/changelog/_changelog.dm
Remove unused file.	Removed the unused file.	modular_bandastation/modular_bandastation.dme
Modified the auto changelog workflow to run on all merged pull requests.	Removed the condition that the pull request must not be a merge from upstream.	.github/workflows/auto_changelog.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.