Skip to content

[master] Deprecated in favor of Salt Extension Decorator#64569

Merged
Ch3LL merged 13 commits into
saltstack:masterfrom
garethgreenaway:add_extension_deprecation_decorator
Jun 30, 2023
Merged

[master] Deprecated in favor of Salt Extension Decorator#64569
Ch3LL merged 13 commits into
saltstack:masterfrom
garethgreenaway:add_extension_deprecation_decorator

Conversation

@garethgreenaway

@garethgreenaway garethgreenaway commented Jun 28, 2023

Copy link
Copy Markdown
Contributor

What does this PR do?

Adding a new decorator to indicate when a module is deprecated in favor of a Salt extension

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

Commits signed with GPG?

Yes

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

@garethgreenaway garethgreenaway requested a review from a team as a code owner June 28, 2023 18:14
@garethgreenaway garethgreenaway requested review from Ch3LL and removed request for a team June 28, 2023 18:14
@salt-project-bot-prod-environment salt-project-bot-prod-environment Bot changed the title Deprecated in favor of Salt Extension Decorator [master] Deprecated in favor of Salt Extension Decorator Jun 28, 2023
Ch3LL
Ch3LL previously approved these changes Jun 28, 2023

@Ch3LL Ch3LL left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We need to document this so users know how to properly deprecate modules in favor of Salt extensions. I'm approving this as I'm okay if we do this in a separate PR as it might require more work since we don't have any documentation related to writing a Salt extension currently that I'm aware of.

dmurphy18
dmurphy18 previously approved these changes Jun 28, 2023

@dmurphy18 dmurphy18 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What about modules already with deprecation since moved to extensions in 3006, for example the ESXi module and it's cohorts, should they stay unchanged or be updated once this is merged ?

@garethgreenaway garethgreenaway temporarily deployed to ci June 28, 2023 18:57 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 28, 2023 18:57 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 28, 2023 18:57 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 28, 2023 18:57 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 28, 2023 19:15 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 28, 2023 19:19 — with GitHub Actions Inactive
s0undt3ch
s0undt3ch previously approved these changes Jun 28, 2023
@garethgreenaway garethgreenaway dismissed stale reviews from s0undt3ch, dmurphy18, and Ch3LL via ec6c7e8 June 28, 2023 19:48
Comment thread doc/topics/development/salt_extensions.rst Outdated
Ch3LL
Ch3LL previously approved these changes Jun 28, 2023
Comment thread doc/topics/development/salt_extensions.rst Outdated
Comment thread doc/topics/development/salt_extensions.rst Outdated
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 16:19 — with GitHub Actions Inactive
Comment thread tests/pytests/functional/utils/test_extension_deprecation.py
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 17:05 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 17:05 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 17:05 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 17:05 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 17:06 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 17:06 — with GitHub Actions Inactive
Comment thread tests/pytests/functional/utils/test_extension_deprecation.py

@I3urny I3urny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just needs a minor fix in the documentation. Looks good otherwise.

Comment thread doc/topics/development/salt_extensions.rst Outdated
@garethgreenaway garethgreenaway requested a review from I3urny June 29, 2023 18:12
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 18:29 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 18:29 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 18:29 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 18:29 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 18:47 — with GitHub Actions Inactive
@garethgreenaway garethgreenaway temporarily deployed to ci June 29, 2023 18:50 — with GitHub Actions Inactive
@Ch3LL Ch3LL merged commit f97b3f4 into saltstack:master Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants