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

RFC: Version Numbering #2357

Merged
merged 14 commits into from
May 17, 2023
Merged

Conversation

wenzeslaus
Copy link
Member

@wenzeslaus wenzeslaus commented May 3, 2022

This PR is a RFC for a new version numbering system. The main point is not making any distinction between even and odd version numbers. After 8.2.z, 8.3.0 would follow.

Notably, this RFC does not follow the current RFC procedure (if any), but creates a PR as suggested in the past as a possible improvement of the procedure.

Closes #2335.

doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
doc/development/rfc/version_numbering.md Outdated Show resolved Hide resolved
@wenzeslaus
Copy link
Member Author

Thanks @neteler for the comments. The minor versus micro is clearly an issue.

Copy link
Member

@neteler neteler left a comment

Choose a reason for hiding this comment

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

IMHO ready for PSC voting which should happen before the upcoming 8.3.0 release.

@wenzeslaus
Copy link
Member Author

wenzeslaus commented Aug 28, 2022

I identified some todos, but perhaps they are for next version of the RFC document:

  • discourage 82 and 820 versions, recommend 8.2 and 8.2.0
  • include recommendation for dates
  • specifically discourage linking name and version
    • Example: don't use "GRASS GIS 8 includes foo and bar." when you simply mean "the most recent (current) version includes."
    • Example bad: "The best version was GRASS GIS 7." Example good: "The best version of GRASS GIS was 7."
    • "winGRASS 8.2.0/standalone" in release announcement of 8.2.0 does not make much sense. Obviously, the Windows binary is for the corresponding version.
    • In short comments: G8 is unclear, when the version is important, using v8 is common practice.
    • If version is really needed "The default database driver used by GRASS GIS 7 is SQLite." (as opposed to v6), say "The default database driver used by GRASS GIS is SQLite (since version 7)." so that the version number is always valid - the version of introduction stays the same and does not change.
  • consider clarifying that soft freeze is the branching (aka feature freeze) while code freeze is release RFC version (this came up during PSC meeting)

@wenzeslaus
Copy link
Member Author

Perhaps discussion in #2575 is an opportunity to reflect again on what versioning and branching scheme we want to adopt. Perhaps what is now major.minor is just major, i.e., branch is major, not major.minor, and we drop micro.

@BadAssassin
Copy link
Contributor

BadAssassin commented Oct 21, 2022 via email

@wenzeslaus wenzeslaus force-pushed the rfc-version-numbering branch 2 times, most recently from 20cd6b6 to 676996c Compare October 27, 2022 21:32
@wenzeslaus wenzeslaus modified the milestones: 8.3.0, 8.4.0 Feb 14, 2023
wenzeslaus and others added 2 commits May 12, 2023 14:52
This PR is a RFC for a new version numbering system. The main point is not making any distinction between even and odd version numbers. After 8.2, 8.3 would follow.
Co-authored-by: Veronica Andreo <veroandreo@gmail.com>
@wenzeslaus
Copy link
Member Author

wenzeslaus commented May 12, 2023

I also implemented the minimal changes required by this RFC. Updating version numbers on main is now the same as on release branch, so the script which was capturing the intricacies of even-odd version distinction is now simpler.

As a consequence, the version on the main branch will no longer be in format X.Y.dev and X.Ydev, but always X.Y.Zdev like the release branches. In other words, with this RFC, there is no distinction between even and odd in terms of meaning and there is no distinction in numbering of different branches.

The main branch is simply the upcoming release and the (non-described) branching procedure updates only the version on main, while the branch keeps the original version from main. (Currently both need to be updated.)

The above is a example how this RFC simplifies the branching and release procedure which is an important aspect of this RFC.

The RFC suggests an additional change to the dev labeling (among other things), X.Y.Zdev should become X.Y.Z-dev because that's Semantic Versioning. However, I suggest to implement that separately, perhaps after branching or releasing 8.3.

@wenzeslaus
Copy link
Member Author

I guess a number is needed for this RFC. How does that work?

@wenzeslaus
Copy link
Member Author

wenzeslaus commented May 12, 2023

If accepted as is, it fixes #2335.

utils/update_version.md Outdated Show resolved Hide resolved
@jmckenna
Copy link

Nice addition, +1. (by the way, here was my own definition of versioning, for the MapServer users : https://github.com/MapServer/MapServer/blob/main/SECURITY.md#version-numbering-explained )

@wenzeslaus wenzeslaus modified the milestones: 8.4.0, 8.3.0 May 17, 2023
@wenzeslaus wenzeslaus merged commit 7afbe70 into OSGeo:main May 17, 2023
@wenzeslaus wenzeslaus deleted the rfc-version-numbering branch May 17, 2023 14:32
@neteler
Copy link
Member

neteler commented May 17, 2023

As soon as the PSC adopts this RFC (voting is ongoing in https://lists.osgeo.org/pipermail/grass-psc/), the state will be changed to "Approved".

wenzeslaus added a commit to wenzeslaus/grass that referenced this pull request Aug 11, 2023
In May, several people agreed to merge the finalized RFC in OSGeo#2357 before it was adopted in a face-to-face meeting. In the meantime, the RFC was adopted. This updates the status. 

Adoption email: https://lists.osgeo.org/pipermail/grass-psc/2023-June/002724.html
wenzeslaus added a commit that referenced this pull request Aug 15, 2023
In May, several people agreed to merge the finalized RFC in #2357 before it was adopted in a face-to-face meeting. In the meantime, the RFC was adopted. This updates the status. 

Adoption email: https://lists.osgeo.org/pipermail/grass-psc/2023-June/002724.html
neteler pushed a commit that referenced this pull request Aug 16, 2023
In May, several people agreed to merge the finalized RFC in #2357 before it was adopted in a face-to-face meeting. In the meantime, the RFC was adopted. This updates the status. 

Adoption email: https://lists.osgeo.org/pipermail/grass-psc/2023-June/002724.html
landam pushed a commit to landam/grass that referenced this pull request Oct 25, 2023
In May, several people agreed to merge the finalized RFC in OSGeo#2357 before it was adopted in a face-to-face meeting. In the meantime, the RFC was adopted. This updates the status. 

Adoption email: https://lists.osgeo.org/pipermail/grass-psc/2023-June/002724.html
neteler pushed a commit to nilason/grass that referenced this pull request Nov 7, 2023
This PR is a RFC for a new version numbering system. The main point is not making any distinction between even and odd version numbers. After 8.2, 8.3 would follow.
neteler pushed a commit to nilason/grass that referenced this pull request Nov 7, 2023
In May, several people agreed to merge the finalized RFC in OSGeo#2357 before it was adopted in a face-to-face meeting. In the meantime, the RFC was adopted. This updates the status. 

Adoption email: https://lists.osgeo.org/pipermail/grass-psc/2023-June/002724.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFC Request For Comment (RFC) document
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feat] Let the main branch have x.y.0 version
7 participants