Skip to content

github: tolerate free-text introduction lines in the stack footer parser #1419

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

Open
netproteus wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −0
Open

github: tolerate free-text introduction lines in the stack footer parser #1419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 additions & 0 deletions eden/scm/sapling/ext/github/pull_request_body.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,17 +165,59 @@ def parse_stack_information(body: str) -> List[_StackEntry]:
... '* #4\n')
>>> parse_stack_information(body)
[(False, 1), (False, 2), (True, 42), (False, 4)]

Free-text introduction lines between the modern marker and the bullet
list are tolerated (e.g. customized prose, or the footer was edited by
hand on github.com):
>>> body = (
... 'The original commit message.\n' +
... '---\n' +
... '[//]: # (BEGIN SAPLING FOOTER)\n' +
... 'This stack is best reviewed commit by commit.\n' +
... '\n' +
... '* #1\n' +
... '* __->__ #2\n')
>>> parse_stack_information(body)
[(False, 1), (True, 2)]

Text after the bullet list still ends the list:
>>> body = (
... '[//]: # (BEGIN SAPLING FOOTER)\n' +
... 'Introduction.\n' +
... '* #1\n' +
... 'Not a stack entry.\n' +
... '* #2\n')
>>> parse_stack_information(body)
[(False, 1)]

Without the modern marker (legacy bodies), free text still ends the
search so that detection stays conservative:
>>> body = (
... 'Stack created with [Sapling](https://sapling-scm.com).\n' +
... 'Some other prose.\n' +
... '* #1\n')
>>> parse_stack_information(body)
[]
"""
in_stack_list = False
saw_modern_marker = False
seen_stack_entry = False
stack_entries = []
for line in body.splitlines():
if _line_has_stack_list_marker(line):
in_stack_list = True
saw_modern_marker = saw_modern_marker or line == _SAPLING_FOOTER_MARKER
elif in_stack_list:
match = _STACK_ENTRY.match(line)
if match:
seen_stack_entry = True
arrow, number = match.groups()
stack_entries.append((bool(arrow), int(number, 10)))
elif saw_modern_marker and not seen_stack_entry:
# Free-text introduction between the modern footer marker and
# the bullet list (e.g. prose customized or edited by hand on
# github.com); skip it.
continue
else:
# This must be the end of the list.
break
Expand Down