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.

Sign up for GitHub

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

Add semantic versioning warning #1614

Merged
merged 2 commits into from
Jan 27, 2024
Merged

Add semantic versioning warning #1614

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be44727
Add semantic versioning warning
brycegbrazen Jan 12, 2024
75603b9
Merge the two notes
brycegbrazen Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/source/basic_concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

in the semantic versioning 2.0.0 spec. Rez gives no special bearing to "pre release" identifiers (as defined by
semantic versioning).

Ex. foo-1.0.0 < foo-1.0.0-beta.1

.. _packages-concept:

Packages
Expand Down