Skip to content

Commit a19b966

Browse files
committed
Add release notes for 3.9
1 parent d7c8cc0 commit a19b966

File tree

2 files changed

+43
-11
lines changed

2 files changed

+43
-11
lines changed

doc/cmdline.rst

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,24 @@ Build a wheel and an sdist (tarball) from the package.
5454

5555
Generating ``setup.py`` disabled by default.
5656

57+
.. option:: --use-vcs
58+
59+
Use the files checked in to git or mercurial as the starting list to include
60+
in an sdist, and then apply inclusions and exclusions :ref:`from pyproject.toml
61+
<pyproject_toml_sdist>`.
62+
63+
This is the default for now, but we're planning to switch to ``--no-use-vcs``
64+
as the default in a future version.
65+
66+
.. option:: --no-use-vcs
67+
68+
Create the sdist starting with only the files inside the installed module
69+
or package, along with any inclusions and exclusions defined in pyproject.toml.
70+
71+
With this option, sdists from ``flit build`` are equivalent to those built
72+
by tools calling Flit as a backend, such as `build
73+
<https://pypa-build.readthedocs.io/en/stable/>`_.
74+
5775
.. _publish_cmd:
5876

5977
``flit publish``
@@ -70,19 +88,12 @@ or another repository.
7088
You should normally publish the two formats together.
7189

7290
.. option:: --setup-py
73-
74-
Generate a ``setup.py`` file in the sdist, so it can be installed by older
75-
versions of pip.
76-
7791
.. option:: --no-setup-py
92+
.. option:: --use-vcs
93+
.. option:: --no-use-vcs
7894

79-
Don't generate a setup.py file in the sdist. This is the default.
80-
An sdist built without this will only work with tools that support PEP 517,
81-
but the wheel will still be usable by any compatible tool.
82-
83-
.. versionchanged:: 3.5
84-
85-
Generating ``setup.py`` disabled by default.
95+
These options affecting what goes in the sdist are described for
96+
:ref:`build_cmd` above.
8697

8798
.. option:: --repository <repository>
8899

doc/history.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
Release history
22
===============
33

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

0 commit comments

Comments
 (0)