search

bitprophet / releases

A powerful Sphinx changelog-generating extension.
http://releases.readthedocs.io/
BSD 2-Clause "Simplified" License
176 stars 41 forks source link

:bug: role requires keyword major? #9

Closed dstufft closed 10 years ago

dstufft commented 11 years ago

Maybe I'm just attempting to use this differently then it's designed for, but I have a project which doesn't doesnt a semantic versioning and the version numbers are just YY.MM.NN where NN is just an incrementing version number that gets reset each month.

I noticed if I have this:

* :bug:`56` Add the ``Content-Length`` header to package responses,
  allowing pip to determine the size of the download.
* :release:`13.10.2 <2013-10-02>`
* :release:`13.10.1 <2013-10-02>`
* :release:`13.10.0 <2013-10-02>`

Then nothing gets output, but if I have this:

* :bug:`56 major` Add the ``Content-Length`` header to package responses,
  allowing pip to determine the size of the download.
* :release:`13.10.2 <2013-10-02>`
* :release:`13.10.1 <2013-10-02>`
* :release:`13.10.0 <2013-10-02>`

Then for the "Unreleased" view I can see the bug that was fixed. However if I then release this as 13.10.3 with the major keyword in place the bug is still shown as unreleased. There doesn't seem to be a configuration type that allows me to just build up a "next" release with features and bug fixes and just release it all together whatever the version number is.

bitprophet commented 10 years ago

I think there's just a general problem with 'unreleased' - I don't remember intending for it to hide non-major bugs, but it does even in normal situations (aka not yours), and I also sometimes see the problem where it shows up in both a real release and 'unreleased'.

Will try to dig soon.

bitprophet commented 10 years ago

Hilariously the unreleased feature wasn't actually documented at all. Just gave it a basic doc blurb. Now to dig in and expand that with exactly how it should work, and make sure that the implementation matches.

bitprophet commented 10 years ago

Have some tests finally - and can't recreate the issue now! Checked and it seems to have been at least partly fixed somewhere between Releases 0.2.0 and 0.2.4. @dstufft please make sure you try out 0.2.4 to see if it fixes it in your situation too!

That said, there's still a related issue - 'Unreleased' only picks up 'feature release' items, and not bugs, so unreleased bugs are effectively hidden. Gonna see about fixing that now :)

bitprophet commented 10 years ago

@dstufft - again plz reopen if your original issue still exists after nabbing latest master / 0.3.0 when that comes out (Today).