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

Bug in draft-release-notes.py when handling colon in summary text #1

Closed
arhag opened this issue Sep 5, 2024 · 1 comment
Closed

Comments

@arhag
Copy link

arhag commented Sep 5, 2024

I believe there is bug here:

parts = line.split(":")
if parts[0] == "group":
meta_data['group'] = parts[1].strip()
if parts[0] == "category":
meta_data['category'] = parts[1].strip()
if parts[0] == "summary":
meta_data['summary'] = parts[1].strip()

Particularly, when capturing the summary from the properly formatted GitHub comment on a PR, it seems that if the summary has a : in it, then it will truncate the rest of the summary on that line.

Examples of this appear to have been seen in practice when preparing Spring 1.0 release notes. Two concrete examples I can point to are the following:

AntelopeIO/leap#2390 (comment) (content reproduced below)

Note:start
group: RELEASE
category: CHORE
summary: CICD: use github provided token for git in submodule regression check.
Note:end

and

AntelopeIO/spring#149 (comment) (content reproduced below)

Note:start
group: IF
category: BUG
summary: P2P: Fix switch from lib catchup to head catchup. Fixes bug which incorrectly assumed blocks in dispatcher list were applied.
Note:end

@ericpassmore
Copy link
Owner

ericpassmore commented Sep 5, 2024

Hah, yes long standing bug. Now fixed with commit 2a53af3 to main.
Screenshot 2024-09-04 at 6 05 46 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants