Skip to content
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.

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

Sanitize changelog before its generation #1035

Merged

Conversation

m-dzianishchyts
Copy link

@m-dzianishchyts m-dzianishchyts commented Jan 21, 2025

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

Удаляет из чейнджлога html комментарии, которые попадают туда после перевода.

Summary by Sourcery

Chores:

  • Prevent HTML comments from being included in the changelog.

@m-dzianishchyts m-dzianishchyts added the 📜 CL не требуется Эти изменения не влияют на игровой процесс или игроки по какой-то причине не должны о них знать label Jan 21, 2025
Copy link

sourcery-ai bot commented Jan 21, 2025

Reviewer's Guide by Sourcery

This pull request sanitizes the changelog by removing HTML comments before its generation. This prevents the inclusion of unnecessary comments in the final changelog.

Flow diagram for changelog sanitization process

flowchart LR
    input[Raw changelog entry] --> parser[Changelog Parser]
    parser --> sanitize[Remove HTML comments]
    sanitize --> validate{Valid entry?}
    validate -->|Yes| output[Clean changelog entry]
    validate -->|No| skip[Skip entry]

    style input fill:#f9f,stroke:#333
    style output fill:#9f9,stroke:#333
    style skip fill:#ff9,stroke:#333
Loading

File-Level Changes

Change Details Files
Sanitize changelog entries by removing HTML comments.
  • Added a regular expression to remove HTML comments from changelog descriptions.
  • Trimmed the description after removing the comments.
tools/pull_request_hooks/changelogParser.js
Removed HTML comments from changelog files.
  • Removed HTML comments from the changelog entries in AutoChangeLog-pr-1028.yml.
  • Removed HTML comments from the changelog entries in AutoChangeLog-pr-1030.yml.
html/changelogs/bandastation/AutoChangeLog-pr-1028.yml
html/changelogs/bandastation/AutoChangeLog-pr-1030.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

@github-actions github-actions bot added 🎸 Инструменты Мы выдаем себя за реальное сообщество разработчиков. 🔧 Фикс Перенос бага в другое место. labels Jan 21, 2025
@m-dzianishchyts m-dzianishchyts merged commit c4b4cdc into ss220club:master Jan 21, 2025
25 of 28 checks passed
@m-dzianishchyts m-dzianishchyts deleted the changelog-sanitize-fix branch January 21, 2025 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎸 Инструменты Мы выдаем себя за реальное сообщество разработчиков. 📜 CL не требуется Эти изменения не влияют на игровой процесс или игроки по какой-то причине не должны о них знать 🔧 Фикс Перенос бага в другое место.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants