search

ros-infrastructure / catkin_pkg

Standalone Python library for the catkin build system.
https://github.com/ros/catkin
Other
47 stars 89 forks source link

catkin_generate_changelog: hack to allow tag version prefixed with v #291

Closed flixr closed 4 years ago

flixr commented 4 years ago

This is not pretty but might help some other people who also want to use catkin_generate_changelog for repos where tags have a v prefix.

130s commented 4 years ago

What about REP-0132 that defines changelog's format?

The version number consists of three positive integers separate by single dots, e.g. 1.2.3 as specified in [8].

dirk-thomas commented 4 years ago

What about REP-0132 that defines changelog's format?

@130s Can you please include more context. At least to me it is unclear what you are trying to say.

130s commented 4 years ago

What about REP-0132 that defines changelog's format?

@130s Can you please include more context. At least to me it is unclear what you are trying to say.

I may be wrong, but my understanding is:

Over the years I've seen developers trying to use version name format that doesn't follow the mentioned syntax. So if there's a room for accommodating custom version format in catkin, I'm +1. If so, I'd just have to suggest to update REP-0132 to clarify that the custom format can be used.

130s commented 4 years ago

Separate argument is that allowing "v" prefix looks very specific. Unless there is a widely accepted versioning scheme that uses "v", it may make more sense to change the functionality so that a user can pass their own custom prefix IMO.

dirk-thomas commented 4 years ago

This patch is just focused on being able to collect the changelog for tags with a v prefix. It shouldn't affect the standard workflow so I don't mind supporting it.

REP 132 only defines the format of a version number in each changelog section. It neither specifies how the information is retrieved from a repository nor mentions catkin_generate_changelog. Therefore I don't see how it should / needs to be updated.

There no promise whatsoever that using tags in the form of vX.Y.Z is supported in any other part of the toolchain. We are happy to take contributions if anyone would like to provide additional flexibility (assuming it is well thought through and has no conceptional or other downsides).

130s commented 4 years ago

@dirk-thomas Then, do I understand correctly that catkin (not catkin_generate_changelog) only supports x.y.z version? If so, I can see developers would be confused when catkin_generate_changelog allows custom version format but catkin doesn't.

dirk-thomas commented 4 years ago

do I understand correctly that catkin (not catkin_generate_changelog) only supports x.y.z version?

What exact part in catkin are you referring to? The package manifest is specified in another REP and implemented in catkin_pkg. I am not sure what else in catkin considers version numbers.

flixr commented 4 years ago

We tag all all releases with a v prefix and this is also already supported by bloom. As @dirk-thomas said that does not mean that the rep should also support this in the changelog.

Dirk Thomas notifications@github.com schrieb am Di., 23. Juni 2020, 19:33:

do I understand correctly that catkin (not catkin_generate_changelog) only supports x.y.z version?

What exact part in catkin are you referring to? The package manifest is specified in another REP and implemented in catkin_pkg. I am not sure what else in catkin considers version numbers.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ros-infrastructure/catkin_pkg/pull/291#issuecomment-648308203, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZOQKHC4YO347YVUEVCIDRYDRPPANCNFSM4NAAMBPA .