Skip to content

Commit 69f7514

Browse files
committed
docs: edit the changelog for 7.0.0
1 parent 5f1067e commit 69f7514

File tree

1 file changed

+61
-18
lines changed

1 file changed

+61
-18
lines changed

CHANGES.rst

Lines changed: 61 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,32 +20,59 @@ development at the same time, such as 4.5.x and 5.0.
2020
Unreleased
2121
----------
2222

23-
(Also see the changes for `6.6.0b1 <changes_6-6-0b1_>`_, since 6.6.0 was never
24-
released.)
23+
A number of changes have been made to file path handling, including pattern
24+
matching and path remapping with the ``[paths]`` setting (see
25+
:ref:`config_paths`). These changes might affect you, and require you to
26+
update your settings.
2527

26-
- Text reporting with ``coverage report`` now has a ``--format=`` option.
27-
The original style (``--format=text``) is the default.
28+
(This release includes the changes from `6.6.0b1 <changes_6-6-0b1_>`_, since
29+
6.6.0 was never released.)
30+
31+
- Changes to file pattern matching, which might require updating your
32+
configuration:
33+
34+
- Previously, ``*`` would incorrectly match directory separators, making
35+
precise matching difficult. This is now fixed, closing `issue 1407`_.
36+
37+
- Now ``**`` matches any number of nested directories, including none.
38+
39+
- Improvements to combining data files when using the
40+
:ref:`config_run_relative_files` setting, which might require updating your
41+
configuration:
42+
43+
- During ``coverage combine``, relative file paths are implicitly combined
44+
without needing a ``[paths]`` configuration setting. This also fixed
45+
`issue 991`_.
46+
47+
- A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that
48+
relative file paths can be combined more easily.
49+
50+
- The :ref:`config_run_relative_files` setting is properly interpreted in
51+
more places, fixing `issue 1280`_.
52+
53+
- When remapping file paths with ``[paths]``, a path will be remapped only if
54+
the resulting path exists. The documentation has long said the prefix had to
55+
exist, but it was never enforced. This fixes `issue 608`_, improves `issue
56+
649`_, and closes `issue 757`_.
57+
58+
- Reporting operations now implicitly use the ``[paths]`` setting to remap file
59+
paths within a single data file. Combining multiple files still requires the
60+
``coverage combine`` step, but this simplifies some single-file situations.
61+
Closes `issue 1212`_ and `issue 713`_.
62+
63+
- The ``coverage report`` command now has a ``--format=`` option. The original
64+
style is now ``--format=text``, and is the default.
2865

2966
- Using ``--format=markdown`` will write the table in Markdown format, thanks
3067
to `Steve Oswald <pull 1479_>`_, closing `issue 1418`_.
3168

3269
- Using ``--format=total`` will write a single total number to the
3370
output. This can be useful for making badges or writing status updates.
3471

35-
- When remapping file paths with the ``[paths]`` setting, a path will be
36-
remapped only if the resulting path exists. The documentation has long said
37-
this was the case, but it was not enforced. This fixes `issue 608`_,
38-
improves `issue 649`_, and closes `issue 757`_.
39-
40-
- Reporting operations now use the ``[paths]`` setting to remap file paths
41-
within a single data file. Combining multiple files still requires the
42-
``coverage combine`` step, but this simplifies some situations. Closes
43-
`issue 1212`_ and `issue 713`_.
44-
45-
- Combining data files with ``coverage combine`` now quickly hashes the data
46-
files to skip files that provide no new information. This can reduce the
47-
time needed. Many details affect the speed-up, but for coverage.py's own
48-
test suite, combining was about 40% faster. Closes `issue 1483`_.
72+
- Combining data files with ``coverage combine`` now hashes the data files to
73+
skip files that add no new information. This can reduce the time needed.
74+
Many details affect the speed-up, but for coverage.py's own test suite,
75+
combining is about 40% faster. Closes `issue 1483`_.
4976

5077
- When searching for completely un-executed files, coverage.py uses the
5178
presence of ``__init__.py`` files to determine which directories have source
@@ -55,6 +82,12 @@ released.)
5582
during reporting. Thanks to `Felix Horvat <pull 1387_>`_ for the
5683
contribution. Closes `issue 1383`_.
5784

85+
- Fixed environment variable expansion in pyproject.toml files. It was overly
86+
broad, causing errors outside of coverage.py settings, as described in `issue
87+
1481`_ and `issue 1345`_. This is now fixed, but in rare cases will require
88+
changing your pyproject.toml to quote non-string values that use environment
89+
substitution.
90+
5891
- An empty file has a coverage total of 100%, but used to fail with
5992
``--fail-under``. This has been fixed, closing `issue 1470`_.
6093

@@ -64,23 +97,33 @@ released.)
6497
- Fixed a mis-measurement of a strange use of wildcard alternatives in
6598
match/case statements, closing `issue 1421`_.
6699

100+
- Fixed internal logic that prevented coverage.py from running on
101+
implementations other than CPython or PyPy (`issue 1474`_).
102+
67103
- The deprecated ``[run] note`` setting has been completely removed.
68104

69105
.. _implicit namespace packages: https://peps.python.org/pep-0420/
70106
.. _issue 608: https://github.com/nedbat/coveragepy/issues/608
71107
.. _issue 649: https://github.com/nedbat/coveragepy/issues/649
72108
.. _issue 713: https://github.com/nedbat/coveragepy/issues/713
73109
.. _issue 757: https://github.com/nedbat/coveragepy/issues/757
110+
.. _issue 991: https://github.com/nedbat/coveragepy/issues/991
74111
.. _issue 1212: https://github.com/nedbat/coveragepy/issues/1212
112+
.. _issue 1280: https://github.com/nedbat/coveragepy/issues/1280
113+
.. _issue 1345: https://github.com/nedbat/coveragepy/issues/1345
75114
.. _issue 1383: https://github.com/nedbat/coveragepy/issues/1383
115+
.. _issue 1407: https://github.com/nedbat/coveragepy/issues/1407
76116
.. _issue 1418: https://github.com/nedbat/coveragepy/issues/1418
77117
.. _issue 1421: https://github.com/nedbat/coveragepy/issues/1421
78118
.. _issue 1470: https://github.com/nedbat/coveragepy/issues/1470
119+
.. _issue 1474: https://github.com/nedbat/coveragepy/issues/1474
120+
.. _issue 1481: https://github.com/nedbat/coveragepy/issues/1481
79121
.. _issue 1483: https://github.com/nedbat/coveragepy/issues/1483
80122
.. _pull 1387: https://github.com/nedbat/coveragepy/pull/1387
81123
.. _pull 1479: https://github.com/nedbat/coveragepy/pull/1479
82124

83125

126+
84127
.. _changes_6-6-0b1:
85128

86129
Version 6.6.0b1 — 2022-10-31

0 commit comments

Comments
 (0)