Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <towncrier:index>` tool
-- by :user:`webknjaz`.

The contributors are now expected to :std:ref:`include
change log fragment files in their pull requests
<adding change notes with your prs>`.

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
<contributing/release_guide>` -- by :user:`webknjaz`.

*Related commits on GitHub:*
:commit:`df0d1a08`.

- The changelog management is now implemented through
the :std:doc:`Towncrier <towncrier:index>` tool
-- by :user:`webknjaz`.

The contributors are now expected to :std:ref:`include
change log fragment files in their pull requests
<adding change notes with your prs>`.

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
=======

Expand Down
3 changes: 0 additions & 3 deletions docs/changelog-fragments.d/27a3c944.packaging.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/310.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/346.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/354.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/358.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/365.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/375.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/4fa1e663.contrib.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/517.bugfix.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/changelog-fragments.d/518.bugfix.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/changelog-fragments.d/5980a3fb.contrib.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/599.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/641.bugfix.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/changelog-fragments.d/649.bugfix.rst

This file was deleted.

29 changes: 0 additions & 29 deletions docs/changelog-fragments.d/654.contrib.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/654.packaging.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/changelog-fragments.d/65ba7e69.contrib.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/changelog-fragments.d/676edc4e.contrib.rst

This file was deleted.

3 changes: 0 additions & 3 deletions docs/changelog-fragments.d/a7149e0c.contrib.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/be9dbc41.contrib.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/c45f184e.packaging.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/changelog-fragments.d/df0d1a08.contrib.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog-fragments.d/f8a1cc4d.contrib.rst

This file was deleted.