From 92cae105fd6dfdddce8ebeedec4ecaa4fc076cf0 Mon Sep 17 00:00:00 2001 From: Pedro Algarvio Date: Thu, 9 Nov 2023 06:46:32 +0000 Subject: [PATCH] Add deprecation warnings and release notes about ``setup.py`` Signed-off-by: Pedro Algarvio --- doc/topics/releases/templates/3007.0.md.template | 6 ++++++ setup.py | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/doc/topics/releases/templates/3007.0.md.template b/doc/topics/releases/templates/3007.0.md.template index 9b1043c9a44..229918daaad 100644 --- a/doc/topics/releases/templates/3007.0.md.template +++ b/doc/topics/releases/templates/3007.0.md.template @@ -6,6 +6,12 @@ Add release specific details below --> +## Salt's ``setup.py`` customizations +> :warning: **Deprecation Notice**:
+In Salt 3009, the ``setup.py`` file will be stripped of it's custom additions and migrated to a plain ``pyproject.toml`` python package +or whatever is found best during the process of removing the customizations.
+**If you're relying on these customizations please stop as your workflow will break in the future**. + ## Python 3.11 Salt's onedir packages now use Python 3.11 diff --git a/setup.py b/setup.py index 0f5870e9029..b81542d5db0 100755 --- a/setup.py +++ b/setup.py @@ -1225,4 +1225,9 @@ if __name__ == "__main__": warnings.warn( "Warning: distutils is deprecated and shall be removed in Python 3.12, advise migrate to using setuptools" ) + warnings.warn( + "In Salt 3009, the `setup.py` file will be stripped of it's custom additions and migrated to a plain " + "`pyproject.toml` python package or whatever is found best during the process of removing the customizations. " + "If you're relying on these customizations please stop as your workflow will break in the future." + ) setup(distclass=SaltDistribution)