From 28cc7c0ef44c4098cd78f3261324728fe6f975e8 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Tue, 14 Jun 2022 18:46:59 +0100 Subject: [PATCH] Add warning about calling setup.py directly --- docs/userguide/distribution.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/userguide/distribution.rst b/docs/userguide/distribution.rst index d2d0ea88770..7620d11f253 100644 --- a/docs/userguide/distribution.rst +++ b/docs/userguide/distribution.rst @@ -1,6 +1,19 @@ Tagging and "Daily Build" or "Snapshot" Releases ------------------------------------------------ +.. warning:: + Please note that running ``python setup.py ...`` directly is no longer + considered a good practice and that in the future the commands ``egg_info`` + and ``rotate`` will be deprecated. + + As a result, the instructions and information presented in this section + should be considered **transitional** while setuptools don't provide a + mechanism for tagging releases. + + Meanwhile, if you can also consider using :pypi:`setuptools-scm` to achieve + similar objectives. + + When a set of related projects are under development, it may be important to track finer-grained version increments than you would normally use for e.g. "stable" releases. While stable releases might be measured in dotted numbers