summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-03-25 13:40:32 +0000
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-03-25 13:40:32 +0000
commit51d5124b929ecff3ca590a565b994b9cd4922158 (patch)
tree895216504dd235500c8bea400a93863e979aba51
parent4923d1139be9366b3010a6d6e56d4c4980a0ab6e (diff)
downloadpython-setuptools-git-51d5124b929ecff3ca590a565b994b9cd4922158.tar.gz
Add missing breaking change note
-rw-r--r--CHANGES.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/CHANGES.rst b/CHANGES.rst
index 3c6dc17a..23ca2085 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -26,6 +26,15 @@ Breaking Changes
You can check details about the automatic discovery (and how to configure a
different behaviour) in :doc:`/userguide/package_discovery`.
+* #3067: If the file ``pyproject.toml`` exists and it includes project
+ metadata/config (via ``[project]`` table or ``[tool.setuptools]``),
+ a series of new behaviors that are not backward compatible may take place:
+
+ - The default value of ``include_package_data`` will be considered to be ``True``.
+ - Setuptools will attempt to validate the ``pyproject.toml`` file according
+ to PEP 621 specification.
+ - The values specified in ``pyproject.toml`` will take precedence over those
+ specified in ``setup.cfg`` or ``setup.py``.
Changes
^^^^^^^
@@ -63,6 +72,8 @@ Changes
* #3066: Added vendored dependencies for :pypi:`tomli`, :pypi:`validate-pyproject`.
These dependencies are used to read ``pyproject.toml`` files and validate them.
+* #3067: **[EXPERIMENTAL]** When using ``pyproject.toml`` metadata,
+ the default value of ``include_package_data`` is changed to ``True``.
* #3068: **[EXPERIMENTAL]** Add support for ``pyproject.toml`` configuration
(as introduced by :pep:`621`). Configuration parameters not covered by
standards are handled in the ``[tool.setuptools]`` sub-table.