Skip to content

Commit

Permalink
Correct typos and link issues in release notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
freakboy3742 committed Jul 10, 2023
1 parent 0584a89 commit 17e682a
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
28 changes: 14 additions & 14 deletions docs/background/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,46 +15,46 @@ Features
* Android support was upgraded to use Java 17 for builds. (`#1065 <https://github.com/beeware/briefcase/issues/1065>`__)
* On Linux, Docker Desktop and rootless Docker are now supported. (`#1083 <https://github.com/beeware/briefcase/issues/1083>`__)
* The company/author name in the installation path for Windows MSI installers is now optional. (`#1199 <https://github.com/beeware/briefcase/issues/1199>`__)
* macOS code signing is now multithreaded (and therefore much faster!) (`#1201 <https://github.com/beeware/briefcase/issues/1201>`__)
* macOS code signing is now multi-threaded (and therefore much faster!) (`#1201 <https://github.com/beeware/briefcase/issues/1201>`__)
* Briefcase will now honor PEP-621 project fields where they map to Briefcase configuration items. (`#1203 <https://github.com/beeware/briefcase/issues/1203>`__)

Bugfixes
--------

* XML compatibility warnings generated by the Android build have been cleaned up. (`#827 <https://github.com/beeware/briefcase/issues/827>`__)
* Non ASCII characters provided in the ``briefcase new`` wizard are quoted before being put into pyproject.toml. (`#1011 <https://github.com/beeware/briefcase/issues/1011>`__)
* Non ASCII characters provided in the ``briefcase new`` wizard are quoted before being put into ``pyproject.toml``. (`#1011 <https://github.com/beeware/briefcase/issues/1011>`__)
* Requests to the web server are now recorded in the log file. (`#1090 <https://github.com/beeware/briefcase/issues/1090>`__)
* An "Invalid Keystore format" error is no longer raised when signing an app if the local Android keystore was generated with a recent version of Java. (`#1112 <https://github.com/beeware/briefcase/issues/1112>`__)
* Content before a closing square bracket (``]``) or ``.so)`` is no longer stripped by the macOS and iOS log filter. (`#1179 <https://github.com/beeware/briefcase/issues/1179>`__)
* The option to run Linux system packages through Docker was removed. (`#1207 <https://github.com/beeware/briefcase/issues/1207>`__)
* Error handling for incomplete or corrupted Github clones of templates has been improved. (`#1210 <https://github.com/beeware/briefcase/issues/1210>`__)
* Application/Bundle IDs are normalized to replace underscores with dashes when possible (`#1234 <https://github.com/beeware/briefcase/issues/1234>`__)
* Filenames and directories in RPM package definitions are quoted in order to include filenames that include whitespace. (`#1236 <https://github.com/beeware/briefcase/issues/1236>`__)
* Briefcase will no longer display progress bars if the ``FORCE_COLOR`` environment variable is set. (`#1267 <https://github.com/beeware/briefcase/issues/1267>`__)
* When creating a new Briefcase project, the header line in ``pyproject.toml`` now contains the version of Briefcase instead of "Unknown". (`#1276 <https://github.com/beeware/briefcase/issues/1276>`__)
* Android logs no longer include timestamp and PID, making them easier to read on narrow screens. (`#1286 <https://github.com/beeware/briefcase/issues/1286>`__)
* Error handling for incomplete or corrupted Github clones of templates has been improved. (`#1210 <https://github.com/beeware/briefcase/pull/1210>`__)
* Application/Bundle IDs are normalized to replace underscores with dashes when possible (`#1234 <https://github.com/beeware/briefcase/pull/1234>`__)
* Filenames and directories in RPM package definitions are quoted in order to include filenames that include white space. (`#1236 <https://github.com/beeware/briefcase/issues/1236>`__)
* Briefcase will no longer display progress bars if the ``FORCE_COLOR`` environment variable is set. (`#1267 <https://github.com/beeware/briefcase/pull/1267>`__)
* When creating a new Briefcase project, the header line in ``pyproject.toml`` now contains the version of Briefcase instead of "Unknown". (`#1276 <https://github.com/beeware/briefcase/pull/1276>`__)
* Android logs no longer include timestamp and PID, making them easier to read on narrow screens. (`#1286 <https://github.com/beeware/briefcase/pull/1286>`__)
* An warning is no longer logged if the Java identified by macOS is not usable by Briefcase. (`#1305 <https://github.com/beeware/briefcase/issues/1305>`__)
* Incompabitilies with Cookiecutter 2.2.0 have been resolved. (`#1347 <https://github.com/beeware/briefcase/issues/1347>`__)
* Incompatibilities with Cookiecutter 2.2.0 have been resolved. (`#1347 <https://github.com/beeware/briefcase/issues/1347>`__)

Backward Incompatible Changes
-----------------------------

* Names matching modules in the Python standard library, and ``main``, can no longer be used as an appname. (`#853 <https://github.com/beeware/briefcase/issues/853>`__)
* The ``--no-sign`` option for packaging was removed. Briefcase will now prompt for a signing identity during packging, falling back to adhoc/no signing as a default where possible. (`#865 <https://github.com/beeware/briefcase/issues/865>`__)
* Names matching modules in the Python standard library, and ``main``, can no longer be used as an application name. (`#853 <https://github.com/beeware/briefcase/issues/853>`__)
* The ``--no-sign`` option for packaging was removed. Briefcase will now prompt for a signing identity during packaging, falling back to adhoc/no signing as a default where possible. (`#865 <https://github.com/beeware/briefcase/issues/865>`__)
* The version of OpenJDK for Java was updated from 8 to 17. Any Android apps generated on previous versions of Briefcase must be re-generated by running ``briefcase create android gradle``. If customizations were made to files within the generated app, they will need to be manually re-applied after re-running the create command. (`#1065 <https://github.com/beeware/briefcase/issues/1065>`__)
* Flatpak apps no longer default to using the Freedesktop runtime and SDK version 21.08 when a runtime is not specified. Instead, the runtime now must be explicitly defined in the `application configuration <https://briefcase.readthedocs.io/en/latest/reference/platforms/linux/flatpak.html#application-configuration>`__. (`#1272 <https://github.com/beeware/briefcase/issues/1272>`__)
* Flatpak apps no longer default to using the Freedesktop runtime and SDK version 21.08 when a runtime is not specified. Instead, the runtime now must be explicitly defined in the `application configuration <https://briefcase.readthedocs.io/en/latest/reference/platforms/linux/flatpak.html#application-configuration>`__. (`#1272 <https://github.com/beeware/briefcase/pull/1272>`__)


Documentation
-------------

* All code blocks were updated to add a button to copy the relevant contents on to the user's clipboard. (`#1213 <https://github.com/beeware/briefcase/issues/1213>`__)
* All code blocks were updated to add a button to copy the relevant contents on to the user's clipboard. (`#1213 <https://github.com/beeware/briefcase/pull/1213>`__)
* The limitations of using WebKit2 in AppImage were documented. (`#1322 <https://github.com/beeware/briefcase/issues/1322>`__)

Misc
----

* `#856 <https://github.com/beeware/briefcase/issues/856>`__, `#1093 <https://github.com/beeware/briefcase/issues/1093>`__, `#1178 <https://github.com/beeware/briefcase/issues/1178>`__, `#1181 <https://github.com/beeware/briefcase/issues/1181>`__, `#1186 <https://github.com/beeware/briefcase/issues/1186>`__, `#1187 <https://github.com/beeware/briefcase/issues/1187>`__, `#1191 <https://github.com/beeware/briefcase/issues/1191>`__, `#1192 <https://github.com/beeware/briefcase/issues/1192>`__, `#1193 <https://github.com/beeware/briefcase/issues/1193>`__, `#1195 <https://github.com/beeware/briefcase/issues/1195>`__, `#1197 <https://github.com/beeware/briefcase/issues/1197>`__, `#1200 <https://github.com/beeware/briefcase/issues/1200>`__, `#1204 <https://github.com/beeware/briefcase/issues/1204>`__, `#1205 <https://github.com/beeware/briefcase/issues/1205>`__, `#1206 <https://github.com/beeware/briefcase/issues/1206>`__, `#1215 <https://github.com/beeware/briefcase/issues/1215>`__, `#1226 <https://github.com/beeware/briefcase/issues/1226>`__, `#1228 <https://github.com/beeware/briefcase/issues/1228>`__, `#1232 <https://github.com/beeware/briefcase/issues/1232>`__, `#1233 <https://github.com/beeware/briefcase/issues/1233>`__, `#1239 <https://github.com/beeware/briefcase/issues/1239>`__, `#1241 <https://github.com/beeware/briefcase/issues/1241>`__, `#1242 <https://github.com/beeware/briefcase/issues/1242>`__, `#1243 <https://github.com/beeware/briefcase/issues/1243>`__, `#1244 <https://github.com/beeware/briefcase/issues/1244>`__, `#1246 <https://github.com/beeware/briefcase/issues/1246>`__, `#1248 <https://github.com/beeware/briefcase/issues/1248>`__, `#1249 <https://github.com/beeware/briefcase/issues/1249>`__, `#1253 <https://github.com/beeware/briefcase/issues/1253>`__, `#1254 <https://github.com/beeware/briefcase/issues/1254>`__, `#1255 <https://github.com/beeware/briefcase/issues/1255>`__, `#1257 <https://github.com/beeware/briefcase/issues/1257>`__, `#1258 <https://github.com/beeware/briefcase/issues/1258>`__, `#1262 <https://github.com/beeware/briefcase/issues/1262>`__, `#1263 <https://github.com/beeware/briefcase/issues/1263>`__, `#1264 <https://github.com/beeware/briefcase/issues/1264>`__, `#1265 <https://github.com/beeware/briefcase/issues/1265>`__, `#1273 <https://github.com/beeware/briefcase/issues/1273>`__, `#1274 <https://github.com/beeware/briefcase/issues/1274>`__, `#1279 <https://github.com/beeware/briefcase/issues/1279>`__, `#1282 <https://github.com/beeware/briefcase/issues/1282>`__, `#1283 <https://github.com/beeware/briefcase/issues/1283>`__, `#1284 <https://github.com/beeware/briefcase/issues/1284>`__, `#1293 <https://github.com/beeware/briefcase/issues/1293>`__, `#1294 <https://github.com/beeware/briefcase/issues/1294>`__, `#1295 <https://github.com/beeware/briefcase/issues/1295>`__, `#1299 <https://github.com/beeware/briefcase/issues/1299>`__, `#1300 <https://github.com/beeware/briefcase/issues/1300>`__, `#1301 <https://github.com/beeware/briefcase/issues/1301>`__, `#1310 <https://github.com/beeware/briefcase/issues/1310>`__, `#1311 <https://github.com/beeware/briefcase/issues/1311>`__, `#1316 <https://github.com/beeware/briefcase/issues/1316>`__, `#1317 <https://github.com/beeware/briefcase/issues/1317>`__, `#1323 <https://github.com/beeware/briefcase/issues/1323>`__, `#1324 <https://github.com/beeware/briefcase/issues/1324>`__, `#1333 <https://github.com/beeware/briefcase/issues/1333>`__, `#1334 <https://github.com/beeware/briefcase/issues/1334>`__, `#1335 <https://github.com/beeware/briefcase/issues/1335>`__, `#1336 <https://github.com/beeware/briefcase/issues/1336>`__, `#1339 <https://github.com/beeware/briefcase/issues/1339>`__, `#1341 <https://github.com/beeware/briefcase/issues/1341>`__, `#1350 <https://github.com/beeware/briefcase/issues/1350>`__, `#1351 <https://github.com/beeware/briefcase/issues/1351>`__
* `#856 <https://github.com/beeware/briefcase/issues/856>`__, `#1093 <https://github.com/beeware/briefcase/pull/1093>`__, `#1178 <https://github.com/beeware/briefcase/pull/1178>`__, `#1181 <https://github.com/beeware/briefcase/pull/1181>`__, `#1186 <https://github.com/beeware/briefcase/pull/1186>`__, `#1187 <https://github.com/beeware/briefcase/issues/1187>`__, `#1191 <https://github.com/beeware/briefcase/pull/1191>`__, `#1192 <https://github.com/beeware/briefcase/pull/1192>`__, `#1193 <https://github.com/beeware/briefcase/pull/1193>`__, `#1195 <https://github.com/beeware/briefcase/issues/1195>`__, `#1197 <https://github.com/beeware/briefcase/pull/1197>`__, `#1200 <https://github.com/beeware/briefcase/pull/1200>`__, `#1204 <https://github.com/beeware/briefcase/pull/1204>`__, `#1205 <https://github.com/beeware/briefcase/pull/1205>`__, `#1206 <https://github.com/beeware/briefcase/pull/1206>`__, `#1215 <https://github.com/beeware/briefcase/pull/1215>`__, `#1226 <https://github.com/beeware/briefcase/pull/1226>`__, `#1228 <https://github.com/beeware/briefcase/pull/1228>`__, `#1232 <https://github.com/beeware/briefcase/pull/1232>`__, `#1233 <https://github.com/beeware/briefcase/pull/1233>`__, `#1239 <https://github.com/beeware/briefcase/pull/1239>`__, `#1241 <https://github.com/beeware/briefcase/pull/1241>`__, `#1242 <https://github.com/beeware/briefcase/pull/1242>`__, `#1243 <https://github.com/beeware/briefcase/pull/1243>`__, `#1244 <https://github.com/beeware/briefcase/pull/1244>`__, `#1246 <https://github.com/beeware/briefcase/pull/1246>`__, `#1248 <https://github.com/beeware/briefcase/pull/1248>`__, `#1249 <https://github.com/beeware/briefcase/issues/1249>`__, `#1253 <https://github.com/beeware/briefcase/pull/1253>`__, `#1254 <https://github.com/beeware/briefcase/pull/1254>`__, `#1255 <https://github.com/beeware/briefcase/pull/1255>`__, `#1257 <https://github.com/beeware/briefcase/pull/1257>`__, `#1258 <https://github.com/beeware/briefcase/pull/1258>`__, `#1262 <https://github.com/beeware/briefcase/pull/1262>`__, `#1263 <https://github.com/beeware/briefcase/pull/1263>`__, `#1264 <https://github.com/beeware/briefcase/pull/1264>`__, `#1265 <https://github.com/beeware/briefcase/pull/1265>`__, `#1273 <https://github.com/beeware/briefcase/pull/1273>`__, `#1274 <https://github.com/beeware/briefcase/pull/1274>`__, `#1279 <https://github.com/beeware/briefcase/pull/1279>`__, `#1282 <https://github.com/beeware/briefcase/pull/1282>`__, `#1283 <https://github.com/beeware/briefcase/pull/1283>`__, `#1284 <https://github.com/beeware/briefcase/pull/1284>`__, `#1293 <https://github.com/beeware/briefcase/pull/1293>`__, `#1294 <https://github.com/beeware/briefcase/pull/1294>`__, `#1295 <https://github.com/beeware/briefcase/pull/1295>`__, `#1299 <https://github.com/beeware/briefcase/pull/1299>`__, `#1300 <https://github.com/beeware/briefcase/pull/1300>`__, `#1301 <https://github.com/beeware/briefcase/pull/1301>`__, `#1310 <https://github.com/beeware/briefcase/pull/1310>`__, `#1311 <https://github.com/beeware/briefcase/pull/1311>`__, `#1316 <https://github.com/beeware/briefcase/pull/1316>`__, `#1317 <https://github.com/beeware/briefcase/pull/1317>`__, `#1323 <https://github.com/beeware/briefcase/pull/1323>`__, `#1324 <https://github.com/beeware/briefcase/pull/1324>`__, `#1333 <https://github.com/beeware/briefcase/pull/1333>`__, `#1334 <https://github.com/beeware/briefcase/pull/1334>`__, `#1335 <https://github.com/beeware/briefcase/pull/1335>`__, `#1336 <https://github.com/beeware/briefcase/pull/1336>`__, `#1339 <https://github.com/beeware/briefcase/issues/1339>`__, `#1341 <https://github.com/beeware/briefcase/pull/1341>`__, `#1350 <https://github.com/beeware/briefcase/pull/1350>`__, `#1351 <https://github.com/beeware/briefcase/pull/1351>`__


0.3.14 (2023-04-12)
Expand Down
4 changes: 4 additions & 0 deletions docs/spelling_wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Bugfix
Bugfixes
checkmarks
codebase
Cookiecutter
cryptographic
customizations
dev
dialogs
distributable
Expand All @@ -22,10 +24,12 @@ Dockerfile
dr
embeddable
executables
Freedesktop
Flathub
flatpak
Flatpak
Flatpaks
Github
gradle
Gradle
gradlew
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ passenv =
PYENCHANT_LIBRARY_PATH
commands =
!lint-!all : python -m sphinx {[docs]sphinx_args} -b html . {[docs]build_dir}/html
lint : python -m sphinx {[docs]sphinx_args_extra} -b linkcheck . {[docs]build_dir}/links
lint : python -m sphinx {[docs]sphinx_args_extra} -b spelling . {[docs]build_dir}/spell
lint : python -m sphinx {[docs]sphinx_args_extra} -b linkcheck . {[docs]build_dir}/links
all : python -m sphinx {[docs]sphinx_args_extra} -b html . {[docs]build_dir}/html

[testenv:package]
Expand Down

0 comments on commit 17e682a

Please sign in to comment.