Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
4lm opened this issue Dec 5, 2019 · 7 comments · Fixed by #168
Closed
Assignees
Labels
part: documentation 📖 Improvements or additions to documentation type: enhancement ⚙️ Improvement of an existing feature

Comments

@4lm
Copy link
Collaborator

4lm commented Dec 5, 2019

Hi all,

as discussed in OpenEnergyPlatform/omi#26 (comment) 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 4lm added the type: enhancement ⚙️ Improvement of an existing feature label Dec 5, 2019
@4lm 4lm self-assigned this Dec 5, 2019
@4lm 4lm added the type: question ❓ Further information is requested label Dec 5, 2019
@jh-RLI jh-RLI unassigned 4lm May 13, 2020
@Ludee Ludee added part: documentation 📖 Improvements or additions to documentation other: help wanted 🙋 Extra attention is needed v1.5 labels Jan 18, 2021
@Ludee Ludee self-assigned this Jan 18, 2021
@Ludee
Copy link
Member

Ludee commented Jan 18, 2021

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

@jh-RLI
Copy link
Contributor

jh-RLI commented Jan 18, 2021

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.

@chrwm
Copy link
Member

chrwm commented Oct 14, 2021

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.

@christian-rli
Copy link
Contributor

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.

@jh-RLI
Copy link
Contributor

jh-RLI commented Oct 14, 2021

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).

@chrwm chrwm removed the v1.5 label Oct 18, 2021
@jh-RLI jh-RLI moved this to To do in OEMetadata v2.0 May 30, 2024
@Ludee
Copy link
Member

Ludee commented Oct 8, 2024

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

@Ludee Ludee removed the other: help wanted 🙋 Extra attention is needed label Oct 8, 2024
@Ludee Ludee removed the type: question ❓ Further information is requested label Oct 8, 2024
@Ludee Ludee moved this from To do to In progress in OEMetadata v2.0 Oct 8, 2024
Ludee added a commit that referenced this issue Oct 16, 2024
Ludee added a commit that referenced this issue Oct 16, 2024
jh-RLI added a commit that referenced this issue Oct 16, 2024
Refactor version to v20 (2.0) in all files #21
@Ludee Ludee moved this from In progress to Done in OEMetadata v2.0 Oct 18, 2024
@Ludee
Copy link
Member

Ludee commented Oct 18, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation 📖 Improvements or additions to documentation type: enhancement ⚙️ Improvement of an existing feature
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants