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

[Experiment] CI Check deprecation for future releases #376

Open
oerc0122 opened this issue Feb 21, 2025 · 1 comment
Open

[Experiment] CI Check deprecation for future releases #376

oerc0122 opened this issue Feb 21, 2025 · 1 comment
Labels
nice to have Not urgently required, but would be an improvement

Comments

@oerc0122
Copy link
Collaborator

          Do we want to change the standard here to always deprecate as literally `vx.y.z` and add a sed/grep call to ensure there are none remaining before a release can be pushed.

Originally posted by @oerc0122 in pace-neutrons/pace-developers#31 (comment)

@oerc0122 oerc0122 added the nice to have Not urgently required, but would be an improvement label Feb 21, 2025
@ajjackson
Copy link
Collaborator

ajjackson commented Feb 21, 2025

Slightly more detail:

  • Currently the first step in the release instructions is to search for "deprecated" directives which were written with a speculative version number. E.g. say we are currently on v1.5.0:

    • a deprecation warning is added "deprecated since v1.6.0"
    • then we need to make a bugfix release v1.5.1, which includes this warning
    • then the version number in the warning should be corrected to "v1.5.1"

This rarely happens, is tedious to check and could be included in the version-number-bump automation. A couple of possible schemes are:

  • unreleased deprecation warnings should have the literal version test "vx.y.z". This will be easy to grep out and set to the new version, but slightly harder to remember/communicate to developers.
  • unreleased deprecation warnins should be set to any future version number e.g. "v1.6" or "99.9". A slightly smarter regex finds this and uses packaging.version.Version to identify that this is greater than our v1.5.1 release and so should be set to "v1.5.1".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nice to have Not urgently required, but would be an improvement
Projects
None yet
Development

No branches or pull requests

2 participants