diff --git a/CHANGES.rst b/CHANGES.rst index f4128b107d..4158cbf68a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -14,6 +14,167 @@ Changelog .. towncrier release notes start +v10.0.1 +======= + +*(2024-04-22)* + + +Bug fixes +--------- + +- Fixed a flaw where internally unhandled exceptions + could crash the worker threads and eventually starve + the server of its processing resources. It is no + longer and issue and the unhandled errors are now + logged and suppressed except for a few expected + exceptions that are used for normal interruption + requests. + + -- by :user:`cameronbrunner` and :user:`webknjaz` + + *Related issues and pull requests on GitHub:* + :issue:`310`, :issue:`346`, :issue:`354`, :issue:`358`, :issue:`365`, :issue:`375`, :issue:`599`, :issue:`641`, :issue:`649`. + +- Fixed compatibility with Python 3.8 in the built-in + TLS adapter that relies on :py:mod:`python:ssl`. + + Modern Python versions communicate specialized exceptions + :py:exc:`ssl.SSLEOFError` and :py:exc:`ssl.SSLZeroReturnError` + where the older versions errored out in a very generic way. + + -- by :user:`toppk` and :user:`webknjaz` + + *Related issues and pull requests on GitHub:* + :issue:`517`, :issue:`518`. + + +Packaging updates and notes for downstreams +------------------------------------------- + +- Started signing the package distribution artifacts in CI/CD + with Sigstore and uploading them to GitHub Releases + -- by :user:`webknjaz`. + + *Related commits on GitHub:* + :commit:`27a3c944`, :commit:`c45f184e`. + +- The changelog management is now implemented through + the :std:doc:`Towncrier ` tool + -- by :user:`webknjaz`. + + The contributors are now expected to :std:ref:`include + change log fragment files in their pull requests + `. + + These news snippets can link one or more issues or pull + requests, and be of one or more of the following categories: + + * ``bugfix``: A bug fix for something we deemed an improper undesired + behavior that got corrected in the release to match pre-agreed + expectations. + * ``feature``: A new behavior, public APIs. That sort of stuff. + * ``deprecation``: A declaration of future API removals and breaking + changes in behavior. + * ``breaking``: When something public gets removed in a breaking way. + Could be deprecated in an earlier release. + * ``doc``: Notable updates to the documentation structure or build + process. + * ``packaging``: Notes for downstreams about unobvious side effects + and tooling. Changes in the test invocation considerations and + runtime assumptions. + * ``contrib``: Stuff that affects the contributor experience. e.g. + Running tests, building the docs, setting up the development + environment. + * ``misc``: Changes that are hard to assign to any of the above + categories. + + *Related issues and pull requests on GitHub:* + :issue:`654`. + + +Contributor-facing changes +-------------------------- + +- Started type-checking the project with MyPy against a + range of versions instead of just one — Python 3.8–3.12 + -- by :user:`webknjaz`. + + *Related commits on GitHub:* + :commit:`4fa1e663`, :commit:`676edc4e`, :commit:`be9dbc41`. + +- The project how has a :file:`.git-blame-ignore-revs` letting + GitHub know which auto-formatting revisions to ignore. It is + also possible to integrate it locally, if one wants to do so. + + -- by :user:`webknjaz` + + *Related commits on GitHub:* + :commit:`5980a3fb`, :commit:`f8a1cc4d`. + +- The project adopted the ``autopep8`` tool to assist with + automatic code formatting. It is chosen over ``black`` + because it is less intrusive which is important to the + maintainer as it promotes inclusivity. + ``autopep8`` is integrated into the ``pre-commit`` check + runner and is configured to only correct :pep:`8` + violations, avoiding changes to compliant snippets. + + -- by :user:`webknjaz` + + *Related commits on GitHub:* + :commit:`65ba7e69`. + +- The continuous integration and pull request merges have been + set up to only merge pull requests through merge queues + -- by :user:`webknjaz`. + + *Related commits on GitHub:* + :commit:`a7149e0c`. + +- Documented the upgraded :std:doc:`release process + ` -- by :user:`webknjaz`. + + *Related commits on GitHub:* + :commit:`df0d1a08`. + +- The changelog management is now implemented through + the :std:doc:`Towncrier ` tool + -- by :user:`webknjaz`. + + The contributors are now expected to :std:ref:`include + change log fragment files in their pull requests + `. + + These news snippets can link one or more issues or pull + requests, and be of one or more of the following categories: + + * ``bugfix``: A bug fix for something we deemed an improper undesired + behavior that got corrected in the release to match pre-agreed + expectations. + * ``feature``: A new behavior, public APIs. That sort of stuff. + * ``deprecation``: A declaration of future API removals and breaking + changes in behavior. + * ``breaking``: When something public gets removed in a breaking way. + Could be deprecated in an earlier release. + * ``doc``: Notable updates to the documentation structure or build + process. + * ``packaging``: Notes for downstreams about unobvious side effects + and tooling. Changes in the test invocation considerations and + runtime assumptions. + * ``contrib``: Stuff that affects the contributor experience. e.g. + Running tests, building the docs, setting up the development + environment. + * ``misc``: Changes that are hard to assign to any of the above + categories. + + *Related issues and pull requests on GitHub:* + :issue:`654`. + + +---- + + v10.0.0 ======= diff --git a/docs/changelog-fragments.d/27a3c944.packaging.rst b/docs/changelog-fragments.d/27a3c944.packaging.rst deleted file mode 100644 index 49d2768b61..0000000000 --- a/docs/changelog-fragments.d/27a3c944.packaging.rst +++ /dev/null @@ -1,3 +0,0 @@ -Started signing the package distribution artifacts in CI/CD -with Sigstore and uploading them to GitHub Releases --- by :user:`webknjaz`. diff --git a/docs/changelog-fragments.d/310.bugfix.rst b/docs/changelog-fragments.d/310.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/310.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/346.bugfix.rst b/docs/changelog-fragments.d/346.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/346.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/354.bugfix.rst b/docs/changelog-fragments.d/354.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/354.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/358.bugfix.rst b/docs/changelog-fragments.d/358.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/358.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/365.bugfix.rst b/docs/changelog-fragments.d/365.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/365.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/375.bugfix.rst b/docs/changelog-fragments.d/375.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/375.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/4fa1e663.contrib.rst b/docs/changelog-fragments.d/4fa1e663.contrib.rst deleted file mode 120000 index ccd5aad29e..0000000000 --- a/docs/changelog-fragments.d/4fa1e663.contrib.rst +++ /dev/null @@ -1 +0,0 @@ -676edc4e.contrib.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/517.bugfix.rst b/docs/changelog-fragments.d/517.bugfix.rst deleted file mode 120000 index 1a0d235bad..0000000000 --- a/docs/changelog-fragments.d/517.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -518.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/518.bugfix.rst b/docs/changelog-fragments.d/518.bugfix.rst deleted file mode 100644 index 04f9d9c6da..0000000000 --- a/docs/changelog-fragments.d/518.bugfix.rst +++ /dev/null @@ -1,8 +0,0 @@ -Fixed compatibility with Python 3.8 in the built-in -TLS adapter that relies on :py:mod:`python:ssl`. - -Modern Python versions communicate specialized exceptions -:py:exc:`ssl.SSLEOFError` and :py:exc:`ssl.SSLZeroReturnError` -where the older versions errored out in a very generic way. - --- by :user:`toppk` and :user:`webknjaz` diff --git a/docs/changelog-fragments.d/5980a3fb.contrib.rst b/docs/changelog-fragments.d/5980a3fb.contrib.rst deleted file mode 100644 index 28329d7238..0000000000 --- a/docs/changelog-fragments.d/5980a3fb.contrib.rst +++ /dev/null @@ -1,5 +0,0 @@ -The project how has a :file:`.git-blame-ignore-revs` letting -GitHub know which auto-formatting revisions to ignore. It is -also possible to integrate it locally, if one wants to do so. - --- by :user:`webknjaz` diff --git a/docs/changelog-fragments.d/599.bugfix.rst b/docs/changelog-fragments.d/599.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/599.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/641.bugfix.rst b/docs/changelog-fragments.d/641.bugfix.rst deleted file mode 120000 index d327851e77..0000000000 --- a/docs/changelog-fragments.d/641.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -649.bugfix.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/649.bugfix.rst b/docs/changelog-fragments.d/649.bugfix.rst deleted file mode 100644 index a57f97d7a7..0000000000 --- a/docs/changelog-fragments.d/649.bugfix.rst +++ /dev/null @@ -1,9 +0,0 @@ -Fixed a flaw where internally unhandled exceptions -could crash the worker threads and eventually starve -the server of its processing resources. It is no -longer and issue and the unhandled errors are now -logged and suppressed except for a few expected -exceptions that are used for normal interruption -requests. - --- by :user:`cameronbrunner` and :user:`webknjaz` diff --git a/docs/changelog-fragments.d/654.contrib.rst b/docs/changelog-fragments.d/654.contrib.rst deleted file mode 100644 index 54db50eb82..0000000000 --- a/docs/changelog-fragments.d/654.contrib.rst +++ /dev/null @@ -1,29 +0,0 @@ -The changelog management is now implemented through -the :std:doc:`Towncrier ` tool --- by :user:`webknjaz`. - -The contributors are now expected to :std:ref:`include -change log fragment files in their pull requests -`. - -These news snippets can link one or more issues or pull -requests, and be of one or more of the following categories: - -* ``bugfix``: A bug fix for something we deemed an improper undesired - behavior that got corrected in the release to match pre-agreed - expectations. -* ``feature``: A new behavior, public APIs. That sort of stuff. -* ``deprecation``: A declaration of future API removals and breaking - changes in behavior. -* ``breaking``: When something public gets removed in a breaking way. - Could be deprecated in an earlier release. -* ``doc``: Notable updates to the documentation structure or build - process. -* ``packaging``: Notes for downstreams about unobvious side effects - and tooling. Changes in the test invocation considerations and - runtime assumptions. -* ``contrib``: Stuff that affects the contributor experience. e.g. - Running tests, building the docs, setting up the development - environment. -* ``misc``: Changes that are hard to assign to any of the above - categories. diff --git a/docs/changelog-fragments.d/654.packaging.rst b/docs/changelog-fragments.d/654.packaging.rst deleted file mode 120000 index 2101798bba..0000000000 --- a/docs/changelog-fragments.d/654.packaging.rst +++ /dev/null @@ -1 +0,0 @@ -654.contrib.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/65ba7e69.contrib.rst b/docs/changelog-fragments.d/65ba7e69.contrib.rst deleted file mode 100644 index 5abd100023..0000000000 --- a/docs/changelog-fragments.d/65ba7e69.contrib.rst +++ /dev/null @@ -1,9 +0,0 @@ -The project adopted the ``autopep8`` tool to assist with -automatic code formatting. It is chosen over ``black`` -because it is less intrusive which is important to the -maintainer as it promotes inclusivity. -``autopep8`` is integrated into the ``pre-commit`` check -runner and is configured to only correct :pep:`8` -violations, avoiding changes to compliant snippets. - --- by :user:`webknjaz` diff --git a/docs/changelog-fragments.d/676edc4e.contrib.rst b/docs/changelog-fragments.d/676edc4e.contrib.rst deleted file mode 100644 index e8fcff79b2..0000000000 --- a/docs/changelog-fragments.d/676edc4e.contrib.rst +++ /dev/null @@ -1,3 +0,0 @@ -Started type-checking the project with MyPy against a -range of versions instead of just one — Python 3.8–3.12 --- by :user:`webknjaz`. diff --git a/docs/changelog-fragments.d/a7149e0c.contrib.rst b/docs/changelog-fragments.d/a7149e0c.contrib.rst deleted file mode 100644 index 5d2dbf135b..0000000000 --- a/docs/changelog-fragments.d/a7149e0c.contrib.rst +++ /dev/null @@ -1,3 +0,0 @@ -The continuous integration and pull request merges have been -set up to only merge pull requests through merge queues --- by :user:`webknjaz`. diff --git a/docs/changelog-fragments.d/be9dbc41.contrib.rst b/docs/changelog-fragments.d/be9dbc41.contrib.rst deleted file mode 120000 index ccd5aad29e..0000000000 --- a/docs/changelog-fragments.d/be9dbc41.contrib.rst +++ /dev/null @@ -1 +0,0 @@ -676edc4e.contrib.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/c45f184e.packaging.rst b/docs/changelog-fragments.d/c45f184e.packaging.rst deleted file mode 120000 index 94dbf70b9c..0000000000 --- a/docs/changelog-fragments.d/c45f184e.packaging.rst +++ /dev/null @@ -1 +0,0 @@ -27a3c944.packaging.rst \ No newline at end of file diff --git a/docs/changelog-fragments.d/df0d1a08.contrib.rst b/docs/changelog-fragments.d/df0d1a08.contrib.rst deleted file mode 100644 index 1afcbb23fc..0000000000 --- a/docs/changelog-fragments.d/df0d1a08.contrib.rst +++ /dev/null @@ -1,2 +0,0 @@ -Documented the upgraded :std:doc:`release process -` -- by :user:`webknjaz`. diff --git a/docs/changelog-fragments.d/f8a1cc4d.contrib.rst b/docs/changelog-fragments.d/f8a1cc4d.contrib.rst deleted file mode 120000 index c712c24bf4..0000000000 --- a/docs/changelog-fragments.d/f8a1cc4d.contrib.rst +++ /dev/null @@ -1 +0,0 @@ -5980a3fb.contrib.rst \ No newline at end of file