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

Standarise deprecations in CMS4 for framework #10500

Closed
3 of 5 tasks
maxime-rainville opened this issue Sep 9, 2022 · 2 comments
Closed
3 of 5 tasks

Standarise deprecations in CMS4 for framework #10500

maxime-rainville opened this issue Sep 9, 2022 · 2 comments

Comments

@maxime-rainville
Copy link
Contributor

maxime-rainville commented Sep 9, 2022

We need to review and normalise our deprecation notice in CMS4 to facilitate upgrades

Acceptance criteria

  • Code with a @deprecated annotation throw a Deprecation::notice()
  • Code throwing a Deprecation::notice() is annotated with a @deprecated
  • Unit test for deprecated code is not run when deprecation notices are enabled.
  • Our CI is updated to have a build that runs with deprecation warning enabled.
  • Normalise the @deprecated annotation ... within reason.

Note

  • This card is only for the core modules See update below
  • We will most likely ended up deprecating more code after this card is merged.
  • A decision needs to be made about how to handle deprecating whole classes - possibly a constructor will need to be added, and the deprecation notice added via that constructor. -> update - handle via Deprecation::SCOPE_CLASS in __construct().

Update

PRs

@GuySartorelli
Copy link
Member

@emteknetnz The acceptance criteria in this card imply changes will need to be made to the CI - do those changes still need to be made?

@emteknetnz emteknetnz changed the title Process deprecations in CMS4 for framework Standarise deprecations in CMS4 for framework Oct 12, 2022
@GuySartorelli
Copy link
Member

PRs are merged and ACs have all been met or spun off into separate cards. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants