Merge pull request pypa#642 from pypa/relnotes-3.9

Add release notes for 3.9

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+   configuration: doc/conf.py
+
+python:
+   install:
+   - requirements: doc/requirements.txt

doc/cmdline.rst

@@ -54,6 +54,24 @@ Build a wheel and an sdist (tarball) from the package.
 
       Generating ``setup.py`` disabled by default.
 
+.. option:: --use-vcs
+
+   Use the files checked in to git or mercurial as the starting list to include
+   in an sdist, and then apply inclusions and exclusions :ref:`from pyproject.toml
+   <pyproject_toml_sdist>`.
+
+   This is the default for now, but we're planning to switch to ``--no-use-vcs``
+   as the default in a future version.
+
+.. option:: --no-use-vcs
+
+   Create the sdist starting with only the files inside the installed module
+   or package, along with any inclusions and exclusions defined in pyproject.toml.
+
+   With this option, sdists from ``flit build`` are equivalent to those built
+   by tools calling Flit as a backend, such as `build
+   <https://pypa-build.readthedocs.io/en/stable/>`_.
+
 .. _publish_cmd:
 
 ``flit publish``
@@ -70,19 +88,12 @@ or another repository.
    You should normally publish the two formats together.
 
 .. option:: --setup-py
-
-   Generate a ``setup.py`` file in the sdist, so it can be installed by older
-   versions of pip.
-
 .. option:: --no-setup-py
+.. option:: --use-vcs
+.. option:: --no-use-vcs
 
-   Don't generate a setup.py file in the sdist. This is the default.
-   An sdist built without this will only work with tools that support PEP 517,
-   but the wheel will still be usable by any compatible tool.
-
-   .. versionchanged:: 3.5
-
-      Generating ``setup.py`` disabled by default.
+   These options affecting what goes in the sdist are described for
+   :ref:`build_cmd` above.
 
 .. option:: --repository <repository>
 

doc/history.rst

@@ -1,6 +1,27 @@
 Release history
 ===============
 
+Version 3.9
+-----------
+
+- New options :option:`flit build --use-vcs` and :option:`flit build --no-use-vcs`
+  to enable & disable including all committed files in the sdist. For now
+  ``--use-vcs`` is the default, but this is likely to change in a future
+  version, to bring ``flit build`` in line with standard build frontends like
+  ``python -m build`` (:ghpull:`625`).
+- Sdist file names, and the name of the top-level folder in an sdist, are now
+  normalised, in accordance with :pep:`625` (:ghpull:`628`).
+- A statically defined version number can now be parsed from files called
+  ``version.py``, ``_version.py`` or ``__version__.py`` inside a packge, as well
+  as from ``__init__.py``, so executing code is required in fewer cases
+  (:ghpull:`630`).
+- Fix setting the flag for regular files in zip metadata (:ghpull:`639`).
+- The timestamp embedded in the gzip wrapper for sdists now defaults to a fixed
+  date, so building an sdist twice on the same machine should produce identical
+  results, even without any special steps (:ghpull:`635`). Setting
+  :envvar:`SOURCE_DATE_EPOCH` is still recommended for properly
+  :doc:`reproducible builds <reproducible>`.
+
 Version 3.8
 -----------