pbr documentation uses version numbers that do not match the canonical form expected by pbr itself

Bug #1743202 reported by Gaetan Semet
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Fix Released
Undecided
Unassigned
reno
In Progress
Low
Doug Hellmann

Bug Description

Hello

I have configured reno so it should merge all prerelease (see my configuration at [1]), but it does not seem to do it on rendered report. I still have all my beta version (maybe it only supports alpha?)

```
=============
Release Notes
=============

3.0.0
=====
...

3.0.0.b2
========

...
3.0.0.b1
========
...
```

Expected output:
```
```
=============
Release Notes
=============

3.0.0
=====
...
...
...
```

Thanks

[1] https://github.com/Guake/guake/blob/master/releasenotes/config.yaml

Revision history for this message
Gaetan Semet (gaetan-xeberon) wrote :

Reproduce with:
```
git clone https://github.com/Guake/guake
cd guake
make dev
make release-note-news
```

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to reno (master)

Fix proposed to branch: master
Review: https://review.openstack.org/533424

Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Re: collapse_pre_releases does not collapse beta

The guake repository has pre-release tags that don't match the pattern reno is searching for. I've proposed https://github.com/Guake/guake/pull/1067 to set the regex and that seems to fix the problem. The patch submitted against reno improves the debug output from the command, but isn't needed to fix the issue.

Changed in reno:
importance: Undecided → Low
status: New → Triaged
status: Triaged → In Progress
assignee: nobody → Doug Hellmann (doug-hellmann)
Revision history for this message
Gaetan Semet (gaetan-xeberon) wrote : Re: [Bug 1743202] Re: collapse_pre_releases does not collapse beta

Thanks a lot. I have been carefully following the semver doc of pbr ([1])
that give some example of alpha/beta:
"If the alpha portion does not match, the sort order is dev < a < b < c.
Example: 1.0.0.dev8 < 1.0.0.dev9 < 1.0.0.a1.dev3 < 1.0.0.a1 < 1.0.0.b2 <
1.0.0.c1 < 1.0.0."

Is it possible to update this documentation in pbr?

But I also noticed pbr put the 0 before auto alpha versionning, wondered
why.
Now i see this document [2] I understand a little bit better.

Thanks a lot for this lightning speed patch !

[1] https://docs.openstack.org/pbr/latest/user/semver.html
[2]
https://specs.openstack.org/openstack/oslo-specs/specs/juno/pbr-semver.html

Gaetan

-----
Gaetan

2018-01-14 16:22 GMT+01:00 Doug Hellmann <email address hidden>:

> The guake repository has pre-release tags that don't match the pattern
> reno is searching for. I've proposed
> https://github.com/Guake/guake/pull/1067 to set the regex and that seems
> to fix the problem. The patch submitted against reno improves the debug
> output from the command, but isn't needed to fix the issue.
>
> ** Changed in: reno
> Importance: Undecided => Low
>
> ** Changed in: reno
> Status: New => Triaged
>
> ** Changed in: reno
> Status: Triaged => In Progress
>
> ** Changed in: reno
> Assignee: (unassigned) => Doug Hellmann (doug-hellmann)
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1743202
>
> Title:
> collapse_pre_releases does not collapse beta
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/reno/+bug/1743202/+subscriptions
>

Revision history for this message
Gaetan Semet (gaetan-xeberon) wrote :

Thanks a lot. I have been carefully following the semver doc of pbr ([1]) that give some example of alpha/beta:
"If the alpha portion does not match, the sort order is dev < a < b < c. Example: 1.0.0.dev8 < 1.0.0.dev9 < 1.0.0.a1.dev3 < 1.0.0.a1 < 1.0.0.b2 < 1.0.0.c1 < 1.0.0."

Is it possible to update this documentation in pbr?

But I also noticed pbr put the 0 before auto alpha versionning, wondered why.
Now i see this document [2] I understand a little bit better.

Thanks a lot for this lightning speed patch !

[1] https://docs.openstack.org/pbr/latest/user/semver.html
[2] https://specs.openstack.org/openstack/oslo-specs/specs/juno/pbr-semver.html

Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Re: collapse_pre_releases does not collapse beta

Ah, yes, we should fix that documentation. Thanks for the pointer. I'll add pbr to this bug and update the title.

summary: - collapse_pre_releases does not collapse beta
+ pbr documentation uses version numbers that do not match the canonical
+ form expected by pbr itself
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to reno (master)

Reviewed: https://review.openstack.org/533424
Committed: https://git.openstack.org/cgit/openstack/reno/commit/?id=32b5405d0e8bcbee7048aac1247fc95619a08f07
Submitter: Zuul
Branch: master

commit 32b5405d0e8bcbee7048aac1247fc95619a08f07
Author: Doug Hellmann <email address hidden>
Date: Sun Jan 14 10:15:32 2018 -0500

    improve output messages

    Change the order of initialization so the logging module is configured
    before the configuration file is read. This lets us log debug messages
    from the config module.

    Add some information from the config module about which configuration
    file is loaded, and in verbose mode which files we're looking for.

    Add some information to the scanner output to show whether
    collapse_pre_releases is set to true.

    Change-Id: Ia78bc63e2c29de2ac8771b46397a63639012bb90
    Addresses-Bug: #1743202
    Signed-off-by: Doug Hellmann <email address hidden>

Revision history for this message
Doug Hellmann (doug-hellmann) wrote :

The bug tracker for reno has moved to storyboard: https://storyboard.openstack.org/#!/project/933

Revision history for this message
Ben Nemec (bnemec) wrote :

Looks like the pbr docs have been updated to reflect this.

Changed in pbr:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.