( )⚙ D2254 releasenotes: allow notes for multiple directives in a single changeset

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2254

releasenotes: allow notes for multiple directives in a single changeset
ClosedPublic

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

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGa5891e94bfe1: releasenotes: allow notes for multiple directives in a single changeset
Summary

This problem was caught in da91e7309daf8ffc51bf3e6f4b2d8a16ef5af95a. This patch just makes sure there is no warning when we
encounter such a case.

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, 4:59 AM

Can you add tests showing what the new behavior is? The correct behavior should be to include multiple directives in the notes correctly.

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 rHGa5891e94bfe1: releasenotes: allow notes for multiple directives in a single changeset (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 6592

hgext/releasenotes.py

paragraphs = [] paragraphs = []
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'] == 'admonition':
break
if pblock['type'] != 'paragraph': if pblock['type'] != 'paragraph':
repo.ui.warn(_('changeset %s: unexpected block in release ' repo.ui.warn(_('changeset %s: unexpected block in release '
'notes directive %s\n') % (ctx, directive)) 'notes directive %s\n') % (ctx, directive))
if pblock['indent'] > 0: if pblock['indent'] > 0:
paragraphs.append(pblock['lines']) paragraphs.append(pblock['lines'])
else: else:
break break

tests/test-releasenotes-formatting.t

$ hg releasenote -r . $ hg releasenote -r .
Bug Fixes Bug Fixes
========= =========
Title of First Fix Title of First Fix
------------------ ------------------
First paragraph of fix 1. First paragraph of fix 1.
$ cd ..
Using multiple admonitions in same changeset
$ hg init relnotes-multiadmon
$ cd relnotes-multiadmon
$ touch file1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. feature::
>
> Details about new feature.
>
> .. perf::
>
> Improves the execution by 2x
> EOF
$ hg releasenotes -r . $TESTTMP/relnotes-multiple-admonitions
$ cat $TESTTMP/relnotes-multiple-admonitions
New Features
============
* Details about new feature.
Performance Improvements
========================
* Improves the execution by 2x