Skip to content

Commit

Permalink
Allow comments in the changelog section (#1692)
Browse files Browse the repository at this point in the history
## Что этот PR делает
Разрешает писать комментарии в чейнджлоге, которые в сам чейнджлог не
попадут.
В комментарий можно положить ссылку на ПР, оригинальный чейнджлог.
Должно быть удобно для создания ПРа скриптом.

Пример использования.
```
:cl:
add: Добавил новые вещи.
<!-- add: Added new things. (https://github.com/.../pull/1234) -->
/:cl:
  • Loading branch information
m-dzianishchyts authored Dec 8, 2024
1 parent f4567ab commit 3443d5a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions tools/changelog/check_changelog.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
DISCORD_EMBED_DESCRIPTION_LIMIT = 4096

CL_BODY = re.compile(r"(:cl:|🆑)[ \t]*(?P<author>.+?)?\s*\n(?P<content>(.|\n)*?)\n/(:cl:|🆑)", re.MULTILINE)
CL_SPLIT = re.compile(r"\s*((?P<tag>\w+)\s*:)?\s*(?P<message>.*)")
CL_SPLIT = re.compile(r"\s*(?:<!--.*-->)?((?P<tag>\w+)\s*:)?\s*(?P<message>.*)")

DISCORD_TAG_EMOJI = {
"soundadd": ":notes:",
Expand Down Expand Up @@ -95,7 +95,7 @@ def parse_changelog(message: str) -> dict:
else:
if len(cl_changes):
prev_change = cl_changes[-1]
prev_change["message"] += f" {change_parse_result['message']}"
prev_change["message"] += f" {message}"
else:
raise Exception(f"Change with no tag: {cl_line}")

Expand Down

0 comments on commit 3443d5a

Please sign in to comment.