From 283e763fc62ff4fc6065ac5c99462753888f9c8a Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Tue, 6 Feb 2024 13:48:38 +0800 Subject: [PATCH] Add release notes for v0.4.2. --- changes/1798.doc.rst | 1 - changes/2190.bugfix.rst | 1 - changes/2190.feature.1.rst | 1 - changes/2190.feature.2.rst | 1 - changes/2190.removal.rst | 1 - changes/2211.bugfix.rst | 1 - changes/2266.feature.rst | 1 - changes/2298.misc.rst | 1 - changes/2299.misc.rst | 1 - changes/2302.misc.rst | 1 - changes/2312.misc.rst | 1 - changes/2313.misc.rst | 1 - changes/2318.misc.rst | 1 - changes/2319.bugfix.rst | 1 - changes/2319.removal.rst | 1 - changes/2331.misc.rst | 1 - changes/2332.misc.rst | 1 - changes/2333.misc.rst | 1 - changes/2336.misc.rst | 1 - changes/2337.misc.rst | 1 - changes/2338.bugfix.rst | 1 - changes/2339.misc.rst | 1 - changes/2340.misc.rst | 1 - changes/2346.feature.rst | 1 - changes/2347.bugfix.rst | 1 - changes/2348.doc.rst | 1 - changes/2353.feature.rst | 1 - changes/2353.removal.rst | 1 - changes/2355.bugfix.rst | 1 - changes/2357.misc.rst | 1 - changes/2358.misc.rst | 1 - changes/2359.misc.rst | 1 - changes/2363.misc.rst | 1 - changes/2367.misc.rst | 1 - changes/2368.misc.rst | 1 - changes/2369.misc.rst | 1 - changes/2370.misc.rst | 1 - changes/2371.misc.rst | 1 - changes/2374.bugfix.rst | 1 - changes/2375.misc.rst | 1 - changes/2376.misc.rst | 1 - changes/774.feature.rst | 1 - docs/background/project/releases.rst | 42 ++++++++++++++++++++++++++++ docs/how-to/internal/release.rst | 12 ++++---- 44 files changed, 47 insertions(+), 49 deletions(-) delete mode 100644 changes/1798.doc.rst delete mode 100644 changes/2190.bugfix.rst delete mode 100644 changes/2190.feature.1.rst delete mode 100644 changes/2190.feature.2.rst delete mode 100644 changes/2190.removal.rst delete mode 100644 changes/2211.bugfix.rst delete mode 100644 changes/2266.feature.rst delete mode 100644 changes/2298.misc.rst delete mode 100644 changes/2299.misc.rst delete mode 100644 changes/2302.misc.rst delete mode 100644 changes/2312.misc.rst delete mode 100644 changes/2313.misc.rst delete mode 100644 changes/2318.misc.rst delete mode 100644 changes/2319.bugfix.rst delete mode 100644 changes/2319.removal.rst delete mode 100644 changes/2331.misc.rst delete mode 100644 changes/2332.misc.rst delete mode 100644 changes/2333.misc.rst delete mode 100644 changes/2336.misc.rst delete mode 100644 changes/2337.misc.rst delete mode 100644 changes/2338.bugfix.rst delete mode 100644 changes/2339.misc.rst delete mode 100644 changes/2340.misc.rst delete mode 100644 changes/2346.feature.rst delete mode 100644 changes/2347.bugfix.rst delete mode 100644 changes/2348.doc.rst delete mode 100644 changes/2353.feature.rst delete mode 100644 changes/2353.removal.rst delete mode 100644 changes/2355.bugfix.rst delete mode 100644 changes/2357.misc.rst delete mode 100644 changes/2358.misc.rst delete mode 100644 changes/2359.misc.rst delete mode 100644 changes/2363.misc.rst delete mode 100644 changes/2367.misc.rst delete mode 100644 changes/2368.misc.rst delete mode 100644 changes/2369.misc.rst delete mode 100644 changes/2370.misc.rst delete mode 100644 changes/2371.misc.rst delete mode 100644 changes/2374.bugfix.rst delete mode 100644 changes/2375.misc.rst delete mode 100644 changes/2376.misc.rst delete mode 100644 changes/774.feature.rst diff --git a/changes/1798.doc.rst b/changes/1798.doc.rst deleted file mode 100644 index 13811e6e17..0000000000 --- a/changes/1798.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Initial documentation of backend-specific features has been added. diff --git a/changes/2190.bugfix.rst b/changes/2190.bugfix.rst deleted file mode 100644 index e20aae3a01..0000000000 --- a/changes/2190.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -New widgets with an ID matching an ID that was previously used no longer cause an error. diff --git a/changes/2190.feature.1.rst b/changes/2190.feature.1.rst deleted file mode 100644 index 19257e2823..0000000000 --- a/changes/2190.feature.1.rst +++ /dev/null @@ -1 +0,0 @@ -Widgets and Windows can now be sorted. The ID of the widget is used for the sorting order. diff --git a/changes/2190.feature.2.rst b/changes/2190.feature.2.rst deleted file mode 100644 index 5c21e4745f..0000000000 --- a/changes/2190.feature.2.rst +++ /dev/null @@ -1 +0,0 @@ -The main window generated by the default ``startup()`` method of an app now has an ID of ``main``. diff --git a/changes/2190.removal.rst b/changes/2190.removal.rst deleted file mode 100644 index dae4c24615..0000000000 --- a/changes/2190.removal.rst +++ /dev/null @@ -1 +0,0 @@ -Widgets must now be added to a window to appear in widget ID lookups. diff --git a/changes/2211.bugfix.rst b/changes/2211.bugfix.rst deleted file mode 100644 index dd26dd9947..0000000000 --- a/changes/2211.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -`App.current_window` on Gtk now returns `None` when all windows are hidden. diff --git a/changes/2266.feature.rst b/changes/2266.feature.rst deleted file mode 100644 index b7155250b2..0000000000 --- a/changes/2266.feature.rst +++ /dev/null @@ -1 +0,0 @@ -A cross-platform API for camera access was added. diff --git a/changes/2298.misc.rst b/changes/2298.misc.rst deleted file mode 100644 index bd8bb5d7c4..0000000000 --- a/changes/2298.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The ``pre-commit`` hook for ``black-pre-commit-mirror`` was updated to its latest version. diff --git a/changes/2299.misc.rst b/changes/2299.misc.rst deleted file mode 100644 index 74df7b3c0b..0000000000 --- a/changes/2299.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated coverage[toml] from 7.3.3 to 7.3.4 in /core. diff --git a/changes/2302.misc.rst b/changes/2302.misc.rst deleted file mode 100644 index 21c69fa200..0000000000 --- a/changes/2302.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The release note describing the backwards-incompatible changes to OptionList was updated. diff --git a/changes/2312.misc.rst b/changes/2312.misc.rst deleted file mode 100644 index 53017390f6..0000000000 --- a/changes/2312.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated pytest from 7.4.3 to 7.4.4 in /core. diff --git a/changes/2313.misc.rst b/changes/2313.misc.rst deleted file mode 100644 index 769cb14acd..0000000000 --- a/changes/2313.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated coverage[toml] from 7.3.4 to 7.4.0 in /core. diff --git a/changes/2318.misc.rst b/changes/2318.misc.rst deleted file mode 100644 index eeb17f0915..0000000000 --- a/changes/2318.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The ``upload-artifact`` and ``download-artifact`` CI actions were upgraded to v4. diff --git a/changes/2319.bugfix.rst b/changes/2319.bugfix.rst deleted file mode 100644 index ada4cd259c..0000000000 --- a/changes/2319.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Selection widgets on macOS can now include duplicated titles. diff --git a/changes/2319.removal.rst b/changes/2319.removal.rst deleted file mode 100644 index cd6686ebca..0000000000 --- a/changes/2319.removal.rst +++ /dev/null @@ -1 +0,0 @@ -If the label for a Selection contains newlines, only the text up to the first newline will be displayed. diff --git a/changes/2331.misc.rst b/changes/2331.misc.rst deleted file mode 100644 index e1b6193e1c..0000000000 --- a/changes/2331.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The ``pre-commit`` hook for ``flake8`` was updated to its latest version. diff --git a/changes/2332.misc.rst b/changes/2332.misc.rst deleted file mode 100644 index 14af76a838..0000000000 --- a/changes/2332.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated pytest-asyncio from 0.23.2 to 0.23.3 in /core. diff --git a/changes/2333.misc.rst b/changes/2333.misc.rst deleted file mode 100644 index f1759fe148..0000000000 --- a/changes/2333.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated pillow from 10.1.0 to 10.2.0 in /core. diff --git a/changes/2336.misc.rst b/changes/2336.misc.rst deleted file mode 100644 index f3b625fc20..0000000000 --- a/changes/2336.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Remove Android get_terminal_size monkey patch diff --git a/changes/2337.misc.rst b/changes/2337.misc.rst deleted file mode 100644 index 59769961dc..0000000000 --- a/changes/2337.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/download-artifact from 4.1.0 to 4.1.1. diff --git a/changes/2338.bugfix.rst b/changes/2338.bugfix.rst deleted file mode 100644 index 5b93b4e11b..0000000000 --- a/changes/2338.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -The padding around DetailedList on Android has been reduced. diff --git a/changes/2339.misc.rst b/changes/2339.misc.rst deleted file mode 100644 index c0251ee621..0000000000 --- a/changes/2339.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated tox from 4.11.4 to 4.12.0 in /core. diff --git a/changes/2340.misc.rst b/changes/2340.misc.rst deleted file mode 100644 index 00d2723e39..0000000000 --- a/changes/2340.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/upload-artifact from 4.0.0 to 4.1.0. diff --git a/changes/2346.feature.rst b/changes/2346.feature.rst deleted file mode 100644 index d77e574e57..0000000000 --- a/changes/2346.feature.rst +++ /dev/null @@ -1 +0,0 @@ -An OptionContainer widget was added for Android. diff --git a/changes/2347.bugfix.rst b/changes/2347.bugfix.rst deleted file mode 100644 index 04270d2050..0000000000 --- a/changes/2347.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -The error returned when an Image is created with no source has been clarified. diff --git a/changes/2348.doc.rst b/changes/2348.doc.rst deleted file mode 100644 index 36d2084eeb..0000000000 --- a/changes/2348.doc.rst +++ /dev/null @@ -1 +0,0 @@ -The difference between Icon and Image was clarified, and a note about the lack of an ``on_press`` handler on ImageView was added. diff --git a/changes/2353.feature.rst b/changes/2353.feature.rst deleted file mode 100644 index b7679413cf..0000000000 --- a/changes/2353.feature.rst +++ /dev/null @@ -1 +0,0 @@ -An Android implementation of the Camera API was added. diff --git a/changes/2353.removal.rst b/changes/2353.removal.rst deleted file mode 100644 index 1caef1aa16..0000000000 --- a/changes/2353.removal.rst +++ /dev/null @@ -1 +0,0 @@ -The internal Android method ``intent_result`` has been deprecated. This was an internal API, and not formally documented, but it was the easiest mechanism for invoking Intents on the Android backend. It has been replaced by the synchronous ``start_activity`` method that allows you to register a callback when the intent completes. diff --git a/changes/2355.bugfix.rst b/changes/2355.bugfix.rst deleted file mode 100644 index b64e85021f..0000000000 --- a/changes/2355.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -On macOS, `toga.Image()` objects can now be created from raw data that didn't originate from a file. diff --git a/changes/2357.misc.rst b/changes/2357.misc.rst deleted file mode 100644 index b5895459bd..0000000000 --- a/changes/2357.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/upload-artifact from 4.1.0 to 4.2.0. diff --git a/changes/2358.misc.rst b/changes/2358.misc.rst deleted file mode 100644 index e159c5ff74..0000000000 --- a/changes/2358.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated tox from 4.12.0 to 4.12.1 in /core. diff --git a/changes/2359.misc.rst b/changes/2359.misc.rst deleted file mode 100644 index 85d291fdcb..0000000000 --- a/changes/2359.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated sphinx-tabs from 3.4.4 to 3.4.5 in /core. diff --git a/changes/2363.misc.rst b/changes/2363.misc.rst deleted file mode 100644 index e0ec12ca4d..0000000000 --- a/changes/2363.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Examples were updated to explicitly list Android Gradle dependencies. diff --git a/changes/2367.misc.rst b/changes/2367.misc.rst deleted file mode 100644 index b1398828d0..0000000000 --- a/changes/2367.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/upload-artifact from 4.2.0 to 4.3.0. diff --git a/changes/2368.misc.rst b/changes/2368.misc.rst deleted file mode 100644 index bd8bb5d7c4..0000000000 --- a/changes/2368.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The ``pre-commit`` hook for ``black-pre-commit-mirror`` was updated to its latest version. diff --git a/changes/2369.misc.rst b/changes/2369.misc.rst deleted file mode 100644 index 39c36e17c2..0000000000 --- a/changes/2369.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated coverage[toml] from 7.4.0 to 7.4.1 in /core. diff --git a/changes/2370.misc.rst b/changes/2370.misc.rst deleted file mode 100644 index b7ec5b6c2d..0000000000 --- a/changes/2370.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated pytest-asyncio from 0.23.3 to 0.23.4 in /core. diff --git a/changes/2371.misc.rst b/changes/2371.misc.rst deleted file mode 100644 index 34a2ed0614..0000000000 --- a/changes/2371.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated sphinx-autodoc-typehints from 1.25.2 to 1.25.3 in /core. diff --git a/changes/2374.bugfix.rst b/changes/2374.bugfix.rst deleted file mode 100644 index 3da9a336f5..0000000000 --- a/changes/2374.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Winforms no longer generates a system beep when pressing Enter in a TextInput. diff --git a/changes/2375.misc.rst b/changes/2375.misc.rst deleted file mode 100644 index 9905559456..0000000000 --- a/changes/2375.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated sphinx-autobuild from 2021.3.14 to 2024.2.4 in /core. diff --git a/changes/2376.misc.rst b/changes/2376.misc.rst deleted file mode 100644 index 48bc8694ce..0000000000 --- a/changes/2376.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated furo from 2023.9.10 to 2024.1.29 in /core. diff --git a/changes/774.feature.rst b/changes/774.feature.rst deleted file mode 100644 index 5f74be79de..0000000000 --- a/changes/774.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Buttons can now be created with an icon, instead of a text label. diff --git a/docs/background/project/releases.rst b/docs/background/project/releases.rst index 899895dee8..5531f7e520 100644 --- a/docs/background/project/releases.rst +++ b/docs/background/project/releases.rst @@ -6,6 +6,48 @@ Release History .. towncrier release notes start +0.4.2 (2024-02-06) +================== + +Features +-------- + +* Buttons can now be created with an icon, instead of a text label. (`#774 `__) +* Widgets and Windows can now be sorted. The ID of the widget is used for the sorting order. (`#2190 `__) +* The main window generated by the default ``startup()`` method of an app now has an ID of ``main``. (`#2190 `__) +* A cross-platform API for camera access was added. (`#2266 `__, `#2353 `__) +* An OptionContainer widget was added for Android. (`#2346 `__) + +Bugfixes +-------- + +* New widgets with an ID matching an ID that was previously used no longer cause an error. (`#2190 `__) +* ``App.current_window`` on GTK now returns ``None`` when all windows are hidden. (`#2211 `__) +* Selection widgets on macOS can now include duplicated titles. (`#2319 `__) +* The padding around DetailedList on Android has been reduced. (`#2338 `__) +* The error returned when an Image is created with no source has been clarified. (`#2347 `__) +* On macOS, ``toga.Image`` objects can now be created from raw data that didn't originate from a file. (`#2355 `__) +* Winforms no longer generates a system beep when pressing Enter in a TextInput. (`#2374 `__) + +Backward Incompatible Changes +----------------------------- + +* Widgets must now be added to a window to be available in the widget registry for lookup by ID. (`#2190 `__) +* If the label for a Selection contains newlines, only the text up to the first newline will be displayed. (`#2319 `__) +* The internal Android method ``intent_result`` has been deprecated. This was an internal API, and not formally documented, but it was the easiest mechanism for invoking Intents on the Android backend. It has been replaced by the synchronous ``start_activity`` method that allows you to register a callback when the intent completes. (`#2353 `__) + +Documentation +------------- + +* Initial documentation of backend-specific features has been added. (`#1798 `__) +* The difference between Icon and Image was clarified, and a note about the lack of an ``on_press`` handler on ImageView was added. (`#2348 `__) + +Misc +---- + +* `#2298 `__, `#2299 `__, `#2302 `__, `#2312 `__, `#2313 `__, `#2318 `__, `#2331 `__, `#2332 `__, `#2333 `__, `#2336 `__, `#2337 `__, `#2339 `__, `#2340 `__, `#2357 `__, `#2358 `__, `#2359 `__, `#2363 `__, `#2367 `__, `#2368 `__, `#2369 `__, `#2370 `__, `#2371 `__, `#2375 `__, `#2376 `__ + + 0.4.1 (2023-12-21) ================== diff --git a/docs/how-to/internal/release.rst b/docs/how-to/internal/release.rst index 6a718ed566..b1295a001c 100644 --- a/docs/how-to/internal/release.rst +++ b/docs/how-to/internal/release.rst @@ -37,16 +37,14 @@ The procedure for cutting a new release is as follows: $ tox -e towncrier - to generate the updated release notes. After doing any edits that may be - required, run: + to generate the updated release notes. - .. code-block:: console +#. Build the documentation to ensure that the new release notes don't include any + spelling errors or markup problems: - $ tox -r -e docs-lint,docs + .. code-block:: console - to confirm that there are no spelling errors or formatting problems with the - new release notes, and the docs build using the current documentation tool - versions. + $ tox -e docs-lint,docs #. Tag the release, and push the branch and tag upstream: