Skip to content

Commit

Permalink
Update CHANGELOG for 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nicoddemus committed Oct 24, 2022
1 parent 0f58a14 commit 1921931
Show file tree
Hide file tree
Showing 14 changed files with 78 additions and 39 deletions.
78 changes: 78 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,81 @@
pytest-xdist 3.0.0 (2022-10-24)
===============================

Bug Fixes
---------

- `#813 <https://github.com/pytest-dev/pytest-xdist/issues/813>`_: Cancel shutdown when a crashed worker is restarted.


Deprecations
------------

- `#825 <https://github.com/pytest-dev/pytest-xdist/issues/825>`_: The ``--rsyncdir`` command line argument and ``rsyncdirs`` config variable are deprecated.

The rsync feature will be removed in pytest-xdist 4.0.

- `#826 <https://github.com/pytest-dev/pytest-xdist/issues/826>`_: The ``--looponfail`` command line argument and ``looponfailroots`` config variable are deprecated.

The loop-on-fail feature will be removed in pytest-xdist 4.0.


Improved Documentation
----------------------

- `#791 <https://github.com/pytest-dev/pytest-xdist/issues/791>`_: Document the ``pytest_xdist_auto_num_workers`` hook.

- `#796 <https://github.com/pytest-dev/pytest-xdist/issues/796>`_: Added known limitations section to documentation.

- `#829 <https://github.com/pytest-dev/pytest-xdist/issues/829>`_: Document the ``-n logical`` option.


Features
--------

- `#792 <https://github.com/pytest-dev/pytest-xdist/issues/792>`_: The environment variable ``PYTEST_XDIST_AUTO_NUM_WORKERS`` can now be used to
specify the default for ``-n auto`` and ``-n logical``.

- `#812 <https://github.com/pytest-dev/pytest-xdist/issues/812>`_: Partially restore old initial batch distribution algorithm in ``LoadScheduling``.

pytest orders tests for optimal sequential execution - i. e. avoiding
unnecessary setup and teardown of fixtures. So executing tests in consecutive
chunks is important for optimal performance.

In v1.14, initial test distribution in ``LoadScheduling`` was changed to
round-robin, optimized for the corner case, when the number of tests is less
than ``2 * number of nodes``. At the same time, it became worse for all other
cases.

For example: if some tests use some "heavy" fixture, and these tests fit into
the initial batch, with round-robin distribution the fixture will be created
``min(n_tests, n_workers)`` times, no matter how many other tests there are.

With the old algorithm (before v1.14), if there are enough tests not using
the fixture, the fixture was created only once.

So restore the old behavior for typical cases where the number of tests is
much greater than the number of workers (or, strictly speaking, when there
are at least 2 tests for every node).


Removals
--------

- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``--boxed`` command-line option has been removed. If you still need this functionality, install `pytest-forked <https://pypi.org/project/pytest-forked>`__ separately.


Trivial Changes
---------------

- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``py`` dependency has been dropped.

- `#822 <https://github.com/pytest-dev/pytest-xdist/issues/822>`_: Replace internal usage of ``py.log`` with a custom solution (but with the same interface).

- `#823 <https://github.com/pytest-dev/pytest-xdist/issues/823>`_: Remove usage of ``py._pydir`` as an rsync candidate.

- `#824 <https://github.com/pytest-dev/pytest-xdist/issues/824>`_: Replace internal usages of ``py.path.local`` by ``pathlib.Path``.


pytest-xdist 2.5.0 (2021-12-10)
===============================

Expand Down
1 change: 0 additions & 1 deletion changelog/468.removal.rst

This file was deleted.

1 change: 0 additions & 1 deletion changelog/468.trivial.rst

This file was deleted.

1 change: 0 additions & 1 deletion changelog/791.doc

This file was deleted.

2 changes: 0 additions & 2 deletions changelog/792.feature

This file was deleted.

1 change: 0 additions & 1 deletion changelog/796.doc.rst

This file was deleted.

22 changes: 0 additions & 22 deletions changelog/812.feature

This file was deleted.

1 change: 0 additions & 1 deletion changelog/813.bugfix

This file was deleted.

1 change: 0 additions & 1 deletion changelog/822.trivial.rst

This file was deleted.

1 change: 0 additions & 1 deletion changelog/823.trivial.rst

This file was deleted.

1 change: 0 additions & 1 deletion changelog/824.trivial.rst

This file was deleted.

3 changes: 0 additions & 3 deletions changelog/825.deprecation.rst

This file was deleted.

3 changes: 0 additions & 3 deletions changelog/826.deprecation.rst

This file was deleted.

1 change: 0 additions & 1 deletion changelog/829.doc

This file was deleted.

0 comments on commit 1921931

Please sign in to comment.