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

Remove deprecated functions for semver 3.1.0 (or better semver 4?) #233

Open
tomschr opened this issue Apr 11, 2020 · 0 comments
Open

Remove deprecated functions for semver 3.1.0 (or better semver 4?) #233

tomschr opened this issue Apr 11, 2020 · 0 comments
Assignees
Labels
Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness Question Unclear or open issue subject for debate Release_3.x.y Only for the major release 3

Comments

@tomschr
Copy link
Member

tomschr commented Apr 11, 2020

Situation

In issue #229, we decided to deprecate module level functions, but we haven't discussed the details for our upcoming semver 3 release.

Proposal

When semver 3 is released, remove the following module level functions:

  • semver.compare(?) see Consider keeping compare module level function #258
  • semver.parse
  • semver.parse_version_info
  • semver.format_version
  • semver.bump_{major,minor,patch,prerelease,build}
  • semver.finalize_version
  • semver.match
  • semver.max_ver
  • semver.min_ver
  • semver.replace
  • semver.VersionInfo._asdict
  • semver.VersionInfo._astuple

Suggested Removal Plan

As our deprecation procedure is almost finishd, I would suggest a plan for the upcoming future:

  1. Release 2.10.0 to get DeprecationWarnings and the updated documentation. Done. ✔️
  2. Maybe release further versions in the 2.10.x line if necessary (for other issues) Done. ✔️
  3. Prepare semver 3 line soon and remove deprecated functions in the communicated version. ✔️

Questions

@python-semver/reviewers I think we need to clarify some questions to lay down our removal plan:

  1. Should we start with the semver 3 release after 2.10.0 is published?

    IMHO, we should soon start with working on semver 3. Issues for semver 3 are piling up. I also think, focusing on one Python version (version 3 in this case) helps to make it easier to develop. That means, we can leave Python 2 behind.

  2. Would it be a good idea to keep the deprecated functions for 3.0.0, but remove them in, lets say, version 3.1.0?

    This makes the move a bit smoother as not all deprecated function will vanish all of a sudden when updating to 3.0.0.

  3. Anything else you would like to see it addressed?

Thank for your feedback. 👍


Update: Due to #236, extended the list of deprecated functions with semver.compare(?), semver.match, semver.max_ver, and semver.min_ver. Also mention 2.10.0 and not 2.9.2.

@tomschr tomschr added Release_3.x.y Only for the major release 3 Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness labels Apr 11, 2020
@tomschr tomschr self-assigned this Apr 11, 2020
@tomschr tomschr added this to To do in Release 3 via automation Apr 11, 2020
@tomschr tomschr added the Question Unclear or open issue subject for debate label Apr 12, 2020
@tomschr tomschr changed the title Remove deprecated functions for semver 3 Remove deprecated functions for semver 3.1.0 Apr 20, 2020
@tomschr tomschr moved this from To do to In progress in Release 3 Oct 25, 2020
@tomschr tomschr moved this from In progress to To do in Release 3 Oct 27, 2020
@tomschr tomschr added this to To do in Release 3.1.0 Nov 3, 2020
@tomschr tomschr removed this from To do in Release 3 Nov 3, 2020
@tomschr tomschr changed the title Remove deprecated functions for semver 3.1.0 Remove deprecated functions for semver 3.1.0 (or better semver 4?) Apr 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Not a bug, but increases or improves in value, quality, desirability, or attractiveness Question Unclear or open issue subject for debate Release_3.x.y Only for the major release 3
Projects
No open projects
Development

No branches or pull requests

1 participant