Add semantic versioning warning #1614
Conversation
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
docs/source/basic_concepts.rst
Outdated
| @@ -81,6 +81,13 @@ version than ``1.0``. | |||
| a version number doesn't matter, you can have as many as you like. While you are encouraged to use | |||
| semantic versioning (see `<https://semver.org>`_), it is not enforced. | |||
|
|
|||
| .. note:: | |||
| If you are using semantic versioning, please note that version ordering will NOT behave like described | |||
There was a problem hiding this comment.
I think that this is already covered by the note above. Do you think we could rework the previous note to clarify it a little bit? For example, instead of saying "you are encouraged to use semver", we could say "you are encouraged to use a semver like scheme".
The note already says that alpha and beta have no meaning. Which leads me to think that the misleading part of the note is the last sentence?
There was a problem hiding this comment.
@JeanChristopheMorinPerso Yeah I agree that reiterating that special terms having no meaning is redundant, so I'll remove that.
I think the big thing I wanted to add here is an explicit note that version ordering will not behave like it is described in sem ver. Let me know if this next commit feels better to you.
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
|
Thanks! |
JeanChristopheMorinPerso
merged commit 6bdba31
into
AcademySoftwareFoundation:main
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com> Signed-off-by: Jose Enriquez <jose.enriquez@barnstormvfx.com>
Add semantic versioning ordering warning based on this Slack discussion last month.
This adds a clear note that semantic version ordering differs from Rez version ordering.