External Compatibility Breaks
*****************************
.. These may require users to change the way they use Breezy.
* Drop support for Python < 3.7. (Jelmer Vernooij)
* Factored gettext support out into setuptools-gettext. (Jelmer Vernooij)
New Features
************
.. New commands, options, etc that users may wish to try out.
* Add ``--open`` argument to ``brz propose``. (Jelmer Vernooij)
* New ``brz web-open`` command, which opens a branch or
merge proposal in a web browser. Deprecates ``brz lp-open``.
(Jelmer Vernooij)
Improvements
************
.. Improvements to existing commands, especially improved performance
or memory usage, or better results.
* Various portability fixes for Mac OS X and Windows. (Jelmer Vernooij)
* Ship typing hints. (Jelmer Vernooij)
* Build binary on GitHub for most Python platforms.
(Jelmer Vernooij)
* Drop trivial pkg-version dependency. (Ondřej Pohořelský)
* Drop use of unnecessary ``iso8061`` module for Forge interactions.
(Jelmer Vernooij)
* Support finding GitHub PRs by URL. (Jelmer Vernooij)
Bug Fixes
*********
.. Fixes for situations where brz would previously crash or give incorrect
or undesirable results.
* Fix compatibility with Python 3.11. (Jelmer Vernooij, #1995814)
+ Remove use of PyUnicode_FromUnicode, gone in Python 3.11.
+ Fix reference counter tests for Python 3.11.
* Handle unexpected HTTP Status errors from Dulwich, converting them
to the appropriate Breezy exceptions. (Jelmer Vernooij)
* Handle out of file descriptor errors in ``breezy.dirty_tracker``.
(Jelmer Vernooij)
* git: Properly decode remote tag names rather than leaving them as bytes.
(Jelmer Vernooij)
* Fix compatibility with Dulwich >= 0.20.50. (Jelmer Vernooij)
* Fix ``Tree.get_file_mtime`` in shallow git trees. (Jelmer Vernooij)
Documentation
*************
.. Improved or updated documentation.
* Remove various references to brz-gtk and breezy.
(Jelmer Vernooij, #1926890, #1837056, #1837053)
API Changes
***********
.. Changes that may require updates in plugins or other code that uses
breezy.
* Removed ``breezy.revision.ensure_null``, originally added for
the migation from ``None`` to ``NULL_REVISION``. (Jelmer Vernooij)
* New ``Forge.create_project`` method. (Jelmer Vernooij)
* New ``breezy.forge.get_forge_by_hostname`` function.
(Jelmer Vernooij)
* New ``Tree.is_special_filename`` to match on e.g.
``.gitattributes`` and ``.bzrignore``. (Jelmer Vernooij)
Internals
*********
.. Major internal changes, unlikely to be visible to users or plugin
developers, but interesting for brz developers.
* Switch to using Launchpad REST API for lp: URL lookups,
rather than XML/RPC. (Jelmer Vernooij)
* Migrate from pkg_resources to importlib for entrypoints.
(Jelmer Vernooij)
* New exception ``UnsupportedVcs``. (Jelmer Vernooij)
* Support titles for merge proposals. (Jelmer Vernooij)
* Use standard python infrastructure to mark extensions as
optional. (Jelmer Vernooij)
* Add pyproject.toml. (Jelmer Vernooij)
Testing
*******
.. Fixes and changes that are only relevant to brz's test framework and
suite. This can include new facilities for writing tests, fixes to
spurious test failures and changes to the way things should be tested.
* Increased timeouts since e.g. the setup test takes longer to run
now we're compiling rust files. (Jelmer Vernooij)
* Raise exception for timed out test rather than killing entire process
when hitting timeouts. (Jelmer Vernooij)
* Add xfail lists for Mac OS X and Windows. (Jelmer Vernooij)
* Properly clear BRZ_SSH in tests. (Jelmer Vernooij)
