Calebotomy

Semver.org probably not compat with all downstream

For those that don’t know I currently create packages for AUR, and I used to work on Funtoo, as well as a fork of it Regen2 (which died by my hand). So I’ve got some experience working with BSD-ish style distro’s. I can’t comment on the Debians or Red Hats of the world, other than REPO HELL DRIVES ME NUTS. Now to the topic. Semver seems sane except for 1 thing that it doesn’t mention and an example that encourages it.

A normal version number MUST take the form X.Y.Z where X, Y, and Z are integers. X is the major version, Y is the minor version, and Z is the patch version. Each element MUST increase numerically. For instance: 1.9.0 < 1.10.0 < 1.11.0.



Not all packaging systems are capable of dealing with multipart as actual multiple parts. Lets give a more complete example to break it down. For instance: 1.9.0 < 1.10.0 < 1.11.0 < 2.0.0. That’s what’s supposed to happen… but that’s not how it works. Arch for example see’s versions as strings… so let me show you what happens.

190
1100
1110
200


This is essentially what you could interpret the “.”’s are essentially ignored ( Ok it’s not actually how it works… juster’s comment is more accurate than me but I think it’s a good rule of thumb). They don’t matter they’re like spaces between words, they simply make it easier for a human to read. Never ever, ever, EVER! change the length of your versions to anything BUT larger. You will cause downstream annoyances, sure we’ve tools to work around it, but I don’t want to and it shouldn’t take any extra effort from upstream to make sure this doesn’t happen.

In order to solve this if you ever need to move anything to double digits just don’t go backwards. In other words: 1.9.0 < 1.10.0 < 1.11.0 < 2.00.0 would actually evaluate properly. I find it more likely that in an X.Y.Z schema that you will need X.Y.ZZ though, and maybe X.YY.ZZ. For a project More than 10 years old XX.YY.ZZ could happen. Anything more is probably ridiculous. If you find yourself hitting 99 slow your roll before you reach it by moving to a time based release, no more than once a month for example.

Some people will say that Arch doesn’t have a sane internal representation. Keep in mind that maintain over 300 package now for arch… of those 300 maybe 10 have ever caused me to create a workaround because of this issue. It’s not difficult, so please just be considerate of downstream, it’s a lot easier to acknowledge and be mindful of this than it is to fix downstream in a way that would work for all upstream packages (e.g. we’ve got more to consider that just your package).

UPDATE: Read juster’s comment if you want more information on actual implementation and how I’m slightly wrong.


Share

comments powered by Disqus