This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2255

releasenotes: replace abort with warning while parsing (issue5775)
ClosedPublic

Authored by rishabhmadan96 on Feb 14 2018, 2:31 AM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG658ed9c7442b: releasenotes: replace abort with warning while parsing (issue5775)
Summary

During the 4.5 development cycle, the extension broke on two different changesets.
This fixes the issue by ensuring that it just throws a warning when it encounters
unexpected behaviour, instead of aborting.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

rishabhmadan96 created this revision.Feb 14 2018, 2:31 AM
pulkit added a subscriber: pulkit.Feb 14 2018, 5:01 AM

This one is a bugfix, so please add the issue number in the commit message. Also add related tests as that will help make sure we don't encounter such problems again in future.

rishabhmadan96 added a comment.Feb 14 2018, 7:34 AM

Yeah, my bad. I'll send an updated version with the suggested changes.

durin42 added a subscriber: durin42.Mar 4 2018, 11:00 AM

Friendly ping - should I expect an updated version of this series?

rishabhmadan96 added a comment.Mar 4 2018, 1:28 PM

I totally forgot about this. I'll send them right away.

rishabhmadan96 edited the summary of this revision. (Show Details)Mar 4 2018, 2:17 PM
rishabhmadan96 retitled this revision from releasenotes: replace abort with warning while parsing to releasenotes: replace abort with warning while parsing (issue5775).
rishabhmadan96 updated this revision to Diff 6590.
durin42 accepted this revision.Mar 7 2018, 11:00 AM
This revision is now accepted and ready to land.Mar 7 2018, 11:00 AM
Closed by commit rHG658ed9c7442b: releasenotes: replace abort with warning while parsing (issue5775) (authored by rishabhmadan96). · Explain WhyMar 7 2018, 11:26 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 6590

hgext/releasenotes.py

for j in range(i + 1, len(blocks)): for j in range(i + 1, len(blocks)):
pblock = blocks[j] pblock = blocks[j]
# Margin blocks may appear between paragraphs. Ignore them. # Margin blocks may appear between paragraphs. Ignore them.
if pblock['type'] == 'margin': if pblock['type'] == 'margin':
continue continue
if pblock['type'] != 'paragraph': if pblock['type'] != 'paragraph':
raise error.Abort(_('unexpected block in release notes ' repo.ui.warn(_('unexpected block in release notes '
'directive %s') % directive) 'directive %s\n') % directive)
if pblock['indent'] > 0: if pblock['indent'] > 0:
paragraphs.append(pblock['lines']) paragraphs.append(pblock['lines'])
else: else:
break break
# TODO consider using title as paragraph for more concise notes. # TODO consider using title as paragraph for more concise notes.
if not paragraphs: if not paragraphs:

tests/test-releasenotes-parsing.t

subsection: Feature 1 subsection: Feature 1
paragraph: Some words about the first feature. paragraph: Some words about the first feature.
subsection: Feature 2 subsection: Feature 2
paragraph: Some words about the second feature. That span multiple lines. paragraph: Some words about the second feature. That span multiple lines.
bullet point: bullet point:
paragraph: Bullet item 1 paragraph: Bullet item 1
bullet point: bullet point:
paragraph: Bullet item 2 paragraph: Bullet item 2
Warn user in case of unexpected block while parsing
$ hg init relnotes-warn
$ cd relnotes-warn
$ touch feature1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. feature::
>
> new feature added.
> some words about the feature.
> EOF
$ hg releasenote -r .
unexpected block in release notes directive feature
New Features
============
* new feature added. some words about the feature.
$ cd ..