Skip to content

GOV: adopt EffVer #27702

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

Jump to bottom
Merged
merged 3 commits into from
Feb 8, 2024
Merged

GOV: adopt EffVer #27702

merged 3 commits into from
Feb 8, 2024

Conversation

tacaswell
Copy link
Member

EffVer very closely articulates what we are already doing.

This was discussed on the developer call last week and was positively received.

I used git grep to find all '* version' and * release referring to our releases (I left "minor version" in most places in the minimum dependency document when referring to other projects, but expanded the definition at the top).

I would like approval from 2 other steering council members before we merge.

@tacaswell tacaswell added this to the v3.9.0 milestone Jan 25, 2024
@story645 story645 added governance needs approval from @steering-council and removed topic: text/fonts Documentation: build building the docs labels Jan 25, 2024
timhoffm
timhoffm approved these changes Jan 25, 2024
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Approved with some small changes still needed.

@github-actions github-actions bot added Documentation: user guide files in galleries/users_explain or doc/users Documentation: API files in lib/ and doc/api labels Jan 25, 2024
anntzer
anntzer reviewed Jan 26, 2024
View reviewed changes
@WeatherGod
Copy link
Member

WeatherGod commented Jan 26, 2024 via email

@timhoffm
Copy link
Member

IMHO the point is that we haven't really made any commitment to what our version numbers mean. It's definitively not SemVer because we make breaking changes in minor releases. Even though that happens with a defensive compatibility policy (deprecation periods and not too disruptive changes), these would require a major release in SemVer.

You can only encode one kind of information in the version number, not both new features and degree of compatibility. And chosing between these two compatibility is the more helpful one. I think in practice, we'll continue to have both new features and minor API changes in the minor/meso releases.

While we could define our own meaning for the version numbers, it's better to use a common semantic. Since SemVer is out and EffVer essentially matches our compatibility policy, it's a good choice.

efiring
efiring requested changes Jan 27, 2024
View reviewed changes
Copy link
Member

@efiring efiring left a comment

Choose a reason for hiding this comment

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

One typo, and several places where it looks like
"major" should be "macro" for consistency. Otherwise, fine with me.

tacaswell and others added 2 commits February 6, 2024 21:51
@tacaswell @timhoffm
GOV: adopt EffVer
95c628b 
EffVer very closely articulates what we are already doing.

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@tacaswell
DOC: also standardize "bugfix release" -> "micro release"
53a2807
@tacaswell tacaswell requested a review from efiring February 7, 2024 02:52
@tacaswell
Copy link
Member Author

We have 2 positive SC reviews so I'm going to go ahead and merge this.

@tacaswell tacaswell merged commit 634ee03 into matplotlib:main Feb 8, 2024
@tacaswell tacaswell deleted the pol/adopt_effver branch February 8, 2024 21:16
tacaswell added a commit to tacaswell/website that referenced this pull request Feb 8, 2024
@tacaswell
Add Matplotlib to EffVer usage
0d30996 
As off matplotlib/matplotlib#27702 Matplotlib follows EffVer
@tacaswell tacaswell mentioned this pull request Feb 8, 2024
Merged
jacobtomlinson pushed a commit to jacobtomlinson/website that referenced this pull request Feb 15, 2024
@tacaswell
Add Matplotlib to EffVer usage (#174)
b5eaae5 
As off matplotlib/matplotlib#27702 Matplotlib follows EffVer
@jacobtomlinson jacobtomlinson mentioned this pull request Feb 15, 2024
Merged
@QuLogic QuLogic mentioned this pull request Mar 9, 2024
Merged
1 task
@QuLogic QuLogic mentioned this pull request Apr 2, 2024
Merged
1 task
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Sep 25, 2024
@QuLogic
Remove 'in' from removal substitution for deprecation messages
3396bec 
Ever since matplotlib#27702, the removal will always be a version, and not "two
minor/meso releases later". This tends to get messed up by people writing
custom `message` arguments, and since there's no reason to add the "to"
there instead of in the message any more, move it to the message.

Also, fix the autogenerated message to follow what the docstring says
(Falsy `removal` leaves out the removal date.)
@QuLogic QuLogic mentioned this pull request Sep 25, 2024
Merged
2 tasks
ksunden pushed a commit that referenced this pull request Sep 25, 2024
@QuLogic
Remove 'in' from removal substitution for deprecation messages (#28880)
e43e0bd 
Ever since #27702, the removal will always be a version, and not "two
minor/meso releases later". This tends to get messed up by people writing
custom `message` arguments, and since there's no reason to add the "to"
there instead of in the message any more, move it to the message.

Also, fix the autogenerated message to follow what the docstring says
(Falsy `removal` leaves out the removal date.)
kyracho pushed a commit to kyracho/matplotlib that referenced this pull request Oct 10, 2024
@QuLogic @kyracho
Remove 'in' from removal substitution for deprecation messages (matpl…
9fe440e 
…otlib#28880)

Ever since matplotlib#27702, the removal will always be a version, and not "two
minor/meso releases later". This tends to get messed up by people writing
custom `message` arguments, and since there's no reason to add the "to"
there instead of in the message any more, move it to the message.

Also, fix the autogenerated message to follow what the docstring says
(Falsy `removal` leaves out the removal date.)
@jni jni mentioned this pull request Mar 6, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anntzer anntzer anntzer left review comments

@efiring efiring efiring approved these changes

@timhoffm timhoffm timhoffm approved these changes

@dopplershift dopplershift Awaiting requested review from dopplershift

Assignees
No one assigned
Labels
Documentation: API files in lib/ and doc/api Documentation: build building the docs Documentation: devdocs files in doc/devel Documentation: user guide files in galleries/users_explain or doc/users Documentation governance needs approval from @steering-council topic: text/fonts
Projects
None yet
Milestone
v3.9.0
Development

Successfully merging this pull request may close these issues.
6 participants
@tacaswell @WeatherGod @timhoffm @efiring @anntzer @story645