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

lifecycle: issue deprecation notices in pre-releases #2522

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

SnoopJ
Copy link
Contributor

@SnoopJ SnoopJ commented Oct 14, 2023

Description

This changeset modifies the version check for deprecation warnings so that only the release segment of a version tag is used to check if a warning should be issued. For instance, currently a @deprecation(warning_in="8.0") will not warn in 8.0.0.dev0 because the pre-release is considered to come before the 'final' release.

@dgw mentions that this might make for noisy logs in some cases, but I'm of the opinion that if I am running 8.0.0.dev0, I want to see deprecation warnings that will be current when 8.0.0 is finalized, before that version is tagged. This is a concern for both core usage of in-the-future deprecated features, and for plugin authors who are checking their plugins against a coming release (although the latter is a softer concern).

Closes #2308.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make lint and make test)
  • I have tested the functionality of the things this change touches

@SnoopJ SnoopJ added Low Priority Housekeeping Code cleanup, removal of deprecated stuff, etc. labels Oct 14, 2023
@SnoopJ SnoopJ force-pushed the bugfix/prerelease-deprecation-notices branch from b63d12f to 5862023 Compare October 14, 2023 02:27
Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

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

Well, I tested it, and it works, so… let the bikeshedding begin! But I still like it.

@SnoopJ SnoopJ changed the title Issue deprecation notices in pre-releases lifecycle: issue deprecation notices in pre-releases Oct 14, 2023
Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

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

I like that. We don't really care about the dev/alpha/beta/rc/post version suffix, the release number is all that matter.

Still, technically not a bug, it's a feature. A feature I like. 😁

@Exirel Exirel added this to the 8.0.0 milestone Oct 14, 2023
@dgw dgw merged commit a91ed84 into sopel-irc:master Oct 16, 2023
7 checks passed
@SnoopJ SnoopJ deleted the bugfix/prerelease-deprecation-notices branch November 5, 2023 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping Code cleanup, removal of deprecated stuff, etc. Low Priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecation warnings should be printed for dev versions
3 participants