oemetadata icon indicating copy to clipboard operation
oemetadata copied to clipboard

Restrict version naming in paths, module names etc. to SemVer major and minor but not patch

Open 4lm opened this issue 5 years ago • 5 comments

Hi all,

as discussed in https://github.com/OpenEnergyPlatform/omi/pull/26#issuecomment-562096417 I would like to use restrict version naming in paths, module names etc. to SemVer major and minor but not patch. Refresh on what SemVer versioning means: link

  • this would mean for module paths for example v130/* to v1.3/*
  • this would mean for imports for for example V130 to V1_3

This will give us the possibility to link (URL) to major and minor versions of our schemas, without breaking third party code in the future or making refactors concerning the version number necessary, if there is a patch (backwards compatible change) for a schema rolling in.

What do you think?

4lm avatar Dec 05 '19 17:12 4lm

This should definitely be taken into account. I think we just messed this up in the current minor version. @jh-RLI

Ludee avatar Jan 18 '21 14:01 Ludee

As far as I understand, there is no consensus on this topic yet. I don't understand github as a platform to store different historically grown versions either, but right now this is our solution. If we want to maintain a new structure we have to do it in a bigger revision. Currently, I think it's best to store all versions explicitly.

jh-RLI avatar Jan 18 '21 15:01 jh-RLI

Hi @4lm and @jh-RLI, I don't see further discussions here. If the matter is still urgent, a solution proposal regarding the release v1.5 will do. Otherwise, I would postpone it to the next one and not consider this topic in the current release.

chrwm avatar Oct 14 '21 12:10 chrwm

I agree. Unless there is a strong opinion post in this issue arguing for an adoption of the larger change with this release, I also propose postponing it to a possible future release.

christian-rli avatar Oct 14 '21 12:10 christian-rli

I think this needs to be discussed further as I am not fully aware of the reasons why this will break code.

Some time ago we have introduced a new folder "latest". This should also prevent third party code from breaking when a new version is released (at least for the latest version)?! The old versions are still stored with full version name (e.g. v141).

jh-RLI avatar Oct 14 '21 13:10 jh-RLI

We will simplify the versioning for the OEP according to this idea starting from OEMetadata 2.0

Ludee avatar Oct 08 '24 12:10 Ludee

Very satisfying to close such an old issue. Kudos to @4lm ♥

Ludee avatar Oct 18 '24 08:10 Ludee