Skip to content

Commit

Permalink
[7.4.x] improve plugin list disclaimer (#11398)
Browse files Browse the repository at this point in the history
Co-authored-by: Stefaan Lippens <soxofaan@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and soxofaan authored Sep 6, 2023
1 parent 1de00e9 commit de69883
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 10 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,7 @@ Simon Holesch
Simon Kerr
Skylar Downes
Srinivas Reddy Thatiparthy
Stefaan Lippens
Stefan Farmbauer
Stefan Scherfke
Stefan Zimmermann
Expand Down
1 change: 1 addition & 0 deletions changelog/11391.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improved disclaimer on pytest plugin reference page to better indicate this is an automated, non-curated listing.
22 changes: 17 additions & 5 deletions doc/en/reference/plugin_list.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@

.. _plugin-list:

Plugin List
===========
Pytest Plugin List
==================

PyPI projects that match "pytest-\*" are considered plugins and are listed
automatically together with a manually-maintained list in `the source
code <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
Below is an automated compilation of ``pytest``` plugins available on `PyPI <https://pypi.org>`_.
It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects.
Packages classified as inactive are excluded.

For detailed insights into how this list is generated,
please refer to `the update script <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.

.. warning::

Please be aware that this list is not a curated collection of projects
and does not undergo a systematic review process.
It serves purely as an informational resource to aid in the discovery of ``pytest`` plugins.

Do not presume any endorsement from the ``pytest`` project or its developers,
and always conduct your own quality assessment before incorporating any of these plugins into your own projects.


.. The following conditional uses a different format for this list when
creating a PDF, because otherwise the table gets far too wide for the
page.
Expand Down
22 changes: 17 additions & 5 deletions scripts/update-plugin-list.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,26 @@
FILE_HEAD = r"""
.. _plugin-list:
Plugin List
===========
Pytest Plugin List
==================
PyPI projects that match "pytest-\*" are considered plugins and are listed
automatically together with a manually-maintained list in `the source
code <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
Below is an automated compilation of ``pytest``` plugins available on `PyPI <https://pypi.org>`_.
It includes PyPI projects whose names begin with "pytest-" and a handful of manually selected projects.
Packages classified as inactive are excluded.
For detailed insights into how this list is generated,
please refer to `the update script <https://github.com/pytest-dev/pytest/blob/main/scripts/update-plugin-list.py>`_.
.. warning::
Please be aware that this list is not a curated collection of projects
and does not undergo a systematic review process.
It serves purely as an informational resource to aid in the discovery of ``pytest`` plugins.
Do not presume any endorsement from the ``pytest`` project or its developers,
and always conduct your own quality assessment before incorporating any of these plugins into your own projects.
.. The following conditional uses a different format for this list when
creating a PDF, because otherwise the table gets far too wide for the
page.
Expand Down

0 comments on commit de69883

Please sign in to comment.