Patchwork [3,of,3] Add more tests for formatting and merging of release notes

login
register
mail settings
Submitter Rishabh Madan
Date June 3, 2017, 10:28 p.m.
Message ID <5154239fff11aacb065f.1496528896@bunty>
Download mbox | patch
Permalink /patch/21167/
State Accepted
Headers show

Comments

Rishabh Madan - June 3, 2017, 10:28 p.m.
# HG changeset patch
# User Rishabh Madan <rishabhmadan96@gmail.com>
# Date 1496528205 -7200
#      Sun Jun 04 00:16:45 2017 +0200
# Node ID 5154239fff11aacb065f4de8081884bfba691eed
# Parent  dfc1e6491b96127ae64504e8dad6cac037b80b6a
Add more tests for formatting and merging of release notes
Gregory Szorc - June 6, 2017, 9:41 p.m.
On Tue, Jun 6, 2017 at 12:31 PM, Augie Fackler <raf@durin42.com> wrote:

> On Tue, Jun 06, 2017 at 11:17:11AM -0500, Kevin Bullock wrote:
> > > On Jun 3, 2017, at 17:28, Rishabh Madan <rishabhmadan96@gmail.com>
> wrote:
> > >
> > > # HG changeset patch
> > > # User Rishabh Madan <rishabhmadan96@gmail.com>
> > > # Date 1496528205 -7200
> > > #      Sun Jun 04 00:16:45 2017 +0200
> > > # Node ID 5154239fff11aacb065f4de8081884bfba691eed
> > > # Parent  dfc1e6491b96127ae64504e8dad6cac037b80b6a
> > > Add more tests for formatting and merging of release notes
> >
> > Series looks good with the added tests. I think I'd be ready to land
> > this and start iterating on it, with a goal of having the basic
> > functionality solidified by 4.3 (and thus let us actually use it to
> > generate the 4.3 release notes). What do others think, particularly
> > Greg?
>
> +1 from me. Greg?
>

There are some lingering bugs and large features that need to be dealt
with. But perfect is the enemy of good. If it is going to be actively
iterated on, we should land it and unblock that work.
Gregory Szorc - June 7, 2017, 9:37 p.m.
On Wed, Jun 7, 2017 at 8:24 AM, Kevin Bullock <
kbullock+mercurial@ringworld.org> wrote:

> On Jun 6, 2017, at 16:41, Gregory Szorc <gregory.szorc@gmail.com> wrote:
>
> On Tue, Jun 6, 2017 at 12:31 PM, Augie Fackler <raf@durin42.com> wrote:
>
>> On Tue, Jun 06, 2017 at 11:17:11AM -0500, Kevin Bullock wrote:
>> > > On Jun 3, 2017, at 17:28, Rishabh Madan <rishabhmadan96@gmail.com>
>> wrote:
>> > >
>> > > # HG changeset patch
>> > > # User Rishabh Madan <rishabhmadan96@gmail.com>
>> > > # Date 1496528205 -7200
>> > > #      Sun Jun 04 00:16:45 2017 +0200
>> > > # Node ID 5154239fff11aacb065f4de8081884bfba691eed
>> > > # Parent  dfc1e6491b96127ae64504e8dad6cac037b80b6a
>> > > Add more tests for formatting and merging of release notes
>> >
>> > Series looks good with the added tests. I think I'd be ready to land
>> > this and start iterating on it, with a goal of having the basic
>> > functionality solidified by 4.3 (and thus let us actually use it to
>> > generate the 4.3 release notes). What do others think, particularly
>> > Greg?
>>
>> +1 from me. Greg?
>>
>
> There are some lingering bugs and large features that need to be dealt
> with. But perfect is the enemy of good. If it is going to be actively
> iterated on, we should land it and unblock that work.
>
>
> Are you referring to the bugs that are showing up in the tests, or are
> there other known issues?
>

The "bugs" that I recall are around robustness. IMO there is nothing severe
enough to block the initial landing.
Sean Farley - June 12, 2017, 2:29 a.m.
Gregory Szorc <gregory.szorc@gmail.com> writes:

> On Wed, Jun 7, 2017 at 8:24 AM, Kevin Bullock <
> kbullock+mercurial@ringworld.org> wrote:
>
>> On Jun 6, 2017, at 16:41, Gregory Szorc <gregory.szorc@gmail.com> wrote:
>>
>> On Tue, Jun 6, 2017 at 12:31 PM, Augie Fackler <raf@durin42.com> wrote:
>>
>>> On Tue, Jun 06, 2017 at 11:17:11AM -0500, Kevin Bullock wrote:
>>> > > On Jun 3, 2017, at 17:28, Rishabh Madan <rishabhmadan96@gmail.com>
>>> wrote:
>>> > >
>>> > > # HG changeset patch
>>> > > # User Rishabh Madan <rishabhmadan96@gmail.com>
>>> > > # Date 1496528205 -7200
>>> > > #      Sun Jun 04 00:16:45 2017 +0200
>>> > > # Node ID 5154239fff11aacb065f4de8081884bfba691eed
>>> > > # Parent  dfc1e6491b96127ae64504e8dad6cac037b80b6a
>>> > > Add more tests for formatting and merging of release notes
>>> >
>>> > Series looks good with the added tests. I think I'd be ready to land
>>> > this and start iterating on it, with a goal of having the basic
>>> > functionality solidified by 4.3 (and thus let us actually use it to
>>> > generate the 4.3 release notes). What do others think, particularly
>>> > Greg?
>>>
>>> +1 from me. Greg?
>>>
>>
>> There are some lingering bugs and large features that need to be dealt
>> with. But perfect is the enemy of good. If it is going to be actively
>> iterated on, we should land it and unblock that work.
>>
>>
>> Are you referring to the bugs that are showing up in the tests, or are
>> there other known issues?
>>
>
> The "bugs" that I recall are around robustness. IMO there is nothing severe
> enough to block the initial landing.

Ok then, I've queued this series (some copy-edit on the commit messages,
though) so that we can make progress. Let's do this!

P.S. If I read this incorrectly, then please do prune these commits and
we can discuss the way forward.
Sean Farley - June 12, 2017, 2:34 a.m.
Sean Farley <sean@farley.io> writes:

> Gregory Szorc <gregory.szorc@gmail.com> writes:
>
>> On Wed, Jun 7, 2017 at 8:24 AM, Kevin Bullock <
>> kbullock+mercurial@ringworld.org> wrote:
>>
>>> On Jun 6, 2017, at 16:41, Gregory Szorc <gregory.szorc@gmail.com> wrote:
>>>
>>> On Tue, Jun 6, 2017 at 12:31 PM, Augie Fackler <raf@durin42.com> wrote:
>>>
>>>> On Tue, Jun 06, 2017 at 11:17:11AM -0500, Kevin Bullock wrote:
>>>> > > On Jun 3, 2017, at 17:28, Rishabh Madan <rishabhmadan96@gmail.com>
>>>> wrote:
>>>> > >
>>>> > > # HG changeset patch
>>>> > > # User Rishabh Madan <rishabhmadan96@gmail.com>
>>>> > > # Date 1496528205 -7200
>>>> > > #      Sun Jun 04 00:16:45 2017 +0200
>>>> > > # Node ID 5154239fff11aacb065f4de8081884bfba691eed
>>>> > > # Parent  dfc1e6491b96127ae64504e8dad6cac037b80b6a
>>>> > > Add more tests for formatting and merging of release notes
>>>> >
>>>> > Series looks good with the added tests. I think I'd be ready to land
>>>> > this and start iterating on it, with a goal of having the basic
>>>> > functionality solidified by 4.3 (and thus let us actually use it to
>>>> > generate the 4.3 release notes). What do others think, particularly
>>>> > Greg?
>>>>
>>>> +1 from me. Greg?
>>>>
>>>
>>> There are some lingering bugs and large features that need to be dealt
>>> with. But perfect is the enemy of good. If it is going to be actively
>>> iterated on, we should land it and unblock that work.
>>>
>>>
>>> Are you referring to the bugs that are showing up in the tests, or are
>>> there other known issues?
>>>
>>
>> The "bugs" that I recall are around robustness. IMO there is nothing severe
>> enough to block the initial landing.
>
> Ok then, I've queued this series (some copy-edit on the commit messages,
> though) so that we can make progress. Let's do this!

Also, let's congratulate Rishabh for his first patches!

Patch

diff -r dfc1e6491b96 -r 5154239fff11 tests/test-releasenotes-formatting.t
--- a/tests/test-releasenotes-formatting.t	Sat Jun 03 22:37:44 2017 +0200
+++ b/tests/test-releasenotes-formatting.t	Sun Jun 04 00:16:45 2017 +0200
@@ -254,3 +254,73 @@ 
   -------------
   
   * Short summary of fix 3
+
+Multiple 'Other Changes' sub-sections for every section
+
+  $ hg init multiple-otherchanges
+  $ cd multiple-otherchanges
+
+  $ touch fix1
+  $ hg -q commit -A -l - << EOF
+  > commit 1
+  > 
+  > .. fix:: Title of First Fix
+  > 
+  >    First paragraph of fix 1.
+  > EOF
+
+  $ touch feature1
+  $ hg -q commit -A -l - << EOF
+  > commit 2
+  > 
+  > .. feature:: Title of First Feature
+  > 
+  >    First paragraph of feature 1.
+  > EOF
+
+  $ touch feature2
+  $ hg -q commit -A -l - << EOF
+  > commit 3
+  > 
+  > .. feature::
+  > 
+  >    Short summary of feature 2.
+  > EOF
+
+  $ touch fix2
+  $ hg -q commit -A -l - << EOF
+  > commit 4
+  > 
+  > .. fix::
+  > 
+  >    Short summary of fix 2
+  > EOF
+
+  $ hg releasenotes -r 'all()' $TESTTMP/relnotes-multiple-otherchanges
+  $ cat $TESTTMP/relnotes-multiple-otherchanges
+  New Features
+  ============
+  
+  Title of First Feature
+  ----------------------
+  
+  First paragraph of feature 1.
+  
+  Other Changes
+  -------------
+  
+  * Short summary of feature 2.
+  
+  Bug Fixes
+  =========
+  
+  Title of First Fix
+  ------------------
+  
+  First paragraph of fix 1.
+  
+  Other Changes
+  -------------
+  
+  * Short summary of fix 2
+
diff -r dfc1e6491b96 -r 5154239fff11 tests/test-releasenotes-merging.t
--- a/tests/test-releasenotes-merging.t	Sat Jun 03 22:37:44 2017 +0200
+++ b/tests/test-releasenotes-merging.t	Sun Jun 04 00:16:45 2017 +0200
@@ -110,3 +110,54 @@ 
   This describes a feature from a commit message.
 
   $ cd ..
+
+Bullets don't merge properly
+
+  $ hg init bullets
+  $ cd bullets
+  $ touch fix1
+  $ hg -q commit -A -l - << EOF
+  > commit 1
+  > 
+  > .. fix::
+  > 
+  >    this is fix1.
+  > EOF
+
+  $ touch fix2
+  $ hg -q commit -A -l - << EOF
+  > commit 2
+  > 
+  > .. fix::
+  > 
+  >    this is fix2.
+  > EOF
+
+  $ hg releasenotes -r 'all()' $TESTTMP/relnotes-bullet-problem
+  $ cat $TESTTMP/relnotes-bullet-problem
+  Bug Fixes
+  =========
+  
+  * this is fix1.
+  
+  * this is fix2.
+  $ touch fix3
+  $ hg -q commit -A -l - << EOF
+  > commit 3
+  > 
+  > .. fix::
+  > 
+  >    this is fix3.
+  > EOF
+
+  $ hg releasenotes -r . $TESTTMP/relnotes-bullet-problem
+  $ cat $TESTTMP/relnotes-bullet-problem
+  Bug Fixes
+  =========
+  
+  * this is fix1.
+  
+    this is fix2.
+  
+  * this is fix3.
+