From 7a814faed2b017437a90631932a9e7cf16148b7d Mon Sep 17 00:00:00 2001 From: Romain LE JEUNE Date: Wed, 14 Dec 2022 11:06:51 +0100 Subject: [PATCH] Other: Update release notes. --- Makefile | 2 +- release-notes/bridge_early.md | 244 ++++++++++++++++++++++++++++----- release-notes/bridge_stable.md | 147 +++++++++++++++++--- release-notes/bugs-bridge.txt | 1 - release-notes/notes-bridge.txt | 0 utils/release_notes.sh | 12 +- 6 files changed, 353 insertions(+), 53 deletions(-) delete mode 100644 release-notes/bugs-bridge.txt delete mode 100644 release-notes/notes-bridge.txt diff --git a/Makefile b/Makefile index b43fd137..980b4c4a 100644 --- a/Makefile +++ b/Makefile @@ -281,7 +281,7 @@ updates: install-go-mod-outdated doc: godoc -http=:6060 -release-notes: release-notes/bridge_stable.html release-notes/bridge_early.html +release-notes: release-notes/bridge_stable.html release-notes/bridge_early.html utils/release_notes.sh release-notes/%.html: release-notes/%.md ./utils/release_notes.sh $^ diff --git a/release-notes/bridge_early.md b/release-notes/bridge_early.md index 41fa5a6a..f169c536 100644 --- a/release-notes/bridge_early.md +++ b/release-notes/bridge_early.md @@ -1,26 +1,224 @@ +## v3.0.6 +- 2022-12-12 + +### New +- New IMAP library (https://github.com/ProtonMail/gluon) + - IMAP state managed entirely by the new IMAP library, to increase robustness and performance + - Used ANTLR to generate a correct IMAP parser directly from RFC protocol description + - Implemented an IMAP 'snapshot' system to ensure correct execution of IMAP commands when multiple clients are connected simultaneously + - Full support of IMAP subscription + - Full support of IMAP SEARCH + - Allow users to modify the Gluon data location + - Improved synchronization of local and remote changes +- New API library (https://github.com/ProtonMail/go-proton-api) + - Switched from pmapi to go-proton-api + - Stability and performance improvement +- Other + - Added an option to change IMAP connection mode + - Subfolder support + +### Fixed +- Stability & Reliability improvements + - Optimized SELECT, FETCH and SEARCH performance + - Parallel user unlock (faster startup times) + - Parallel file upload (faster send with attachments) + - Parallel contact fetch (faster send to multiple addresses) + - Implemented batching for increased performance for COPY/MOVE/STORE on multiple messages + - Reduced reliance on OS keychain +- Other + - Implemented sync manager + - Improved handling SMTP send deduplication + - Better user management + - Improved Sentry reporting for easier debugging + - Increase test coverage + - GUI improvements + + +## v2.4.8 +- 2022-11-15 + +### New +- More detailed logs for Bridge GUI +- GUI improvements + +### Fixed +- Improved Bridge <-> Bridge-GUI communication +- Ensuring all the logs files are included when sending a bug report +- Fixes to the update process on Linux and Windows (qt6 related) + + +## v2.4.5 +- 2022-11-08 + +### New +- GUI improvements +- More verbose logs for GUI-related issues +- New icon for .dmg installer + +### Fixed +- Change download and version check urls to proton.me +- Fixed manual check for updates after switching the update channel + + +## v2.4.3 +- 2022-10-25 + +### New +- Ensured the use of random port for gRPC +- Implemented token exchange for identity validation +- Ensured gRPC generates its own TLS certificate +- Increased bridge-gui timeout for gRPC server connection +- Added new warnings for 'TLS pinning' and 'no active key for recipient' errors + +### Fixed +- GUI-related Bridge crashes +- The notification for when Bridge ports are occupied +- Fixed vulnerabilities of golang.org/x/crypto +- Missing Library on Fedora/Gnome upgrade form 2.3 to 2.4 +- Added Digital-Signature for DLLs (Windows Security Alert to show Bridge as coming from a trusted publisher) + + +## v2.4.0 +- 2022-09-28 + +### New +- Native Mac M1 release +- Upgrade to Qt 6: + - Change the app architecture + - Drop therecipe/qt dependency + - Update to go1.18 + - Update to Qt 6.3.2 + +### Fixed +- Improved wording for specific errors +- Improved robustness of Bridge restart +- Status View visual improvements + + +## v2.3.0 +- 2022-09-01 + +### New +- Feature to hide All Mail from IMAP client +- Enable automatic configuration on macOS Ventura +- Improved the scope of local logs + +### Fixed +- Visibility of Dependencies in Bridge GUI +- Potential crashes on parallel LIST command + + +## v2.2.2 +- 2022-07-27 + +### Fixed +- Improvements to manual update process + + +## v2.2.1 +- 2022-07-21 + +### New +- New Bridge systray icons for all OSes +- New Bridge application icons for all OSes +- Visual update of macOS and Windows installers +- Add label/folder filtering to pmapi + +### Fixed +- Updated crypto-libraries to gopenpgp v2.4.7 and go-srp v0.0.5 +- Convert charset only for `text/*` MIME types - to ensure no attachment corruption when sending with some email clients +- Reduced unnecessary shell executions + + +## v2.2.0 +- 2022-05-25 + +### New +- Updated GUI colours to reflect new Proton's colours theme +- Renamed ProtonMail Bridge to Proton Mail Bridge - installers, keychain etc. +- Use one buffered event for internet status changes +- Added a modal to prompt the user to reconfigure the account once a new PM address is added +- Added a link to dependencies' licences to the help section footer + +### Fixed +- Syncing issues for when a new PM address is added +- Changed the wording of 'delete this account' dialog +- Improved manual update process (GUI changes) + + +## v2.1.3 +- 2022-04-11 + +### New +- Added keybase/go-keychain/secretservice as new keychain helper +- GUI changes to report a problem tab + +### Fixed +- Manual update mechanism + + +## v2.1.2 +- 2022-03-29 + +### New +- Added another proxy provider +- Improved UX for working with keychain on macOS + +### Fixed +- Windows clipboard issues (copying account details) +- Random logouts on macOS +- Error for corrupted keychain +- Bug reporting (emails send from custom domain) + + +## v2.1.1 +- 2022-02-09 + +### New +- Improved Sentry reporting + +### Fixed +- Ensure messageID is properly removed from DB when it is no logner present on the API + + +## v2.1.0 +- 2022-01-18 + +### New +- Dark Mode for Bridge, including autodetect mechanism for system colour scheme +- GUI element for changing keychain (Linux) +- Update to goopenpgp 2.4.1 +- Optimising sentry reporting + +### Fixed +- Bridge crashes related to unlocking local cache +- Bug with sending to 'non-encrypted' recipients +- Cosmetic GUI changes + + ## v2.0.1 - 2021-12-15 ### New - New Bridge GUI -* Added a Status View in addition to the Main Bridge Window -* Added storage information per signed in account -* Refactor of sign in flows -- Refactor of Helps and Settings section -- Refactor of bug reports -- Refactor of Bridge update flows for beta and stable channeles +- Added a Status View in addition to the Main Bridge Window +- Added storage information per signed in account +- Refactor of sign in flows +- Refactor of Helps and Settings section +- Refactor of bug reports +- Refactor of Bridge update flows for beta and stable channels - Introduced Reset Bridge feature - to clear all the local preferences and settings - Introduce local cache configuration New local cache -* Refactor of message.BodyStructure -* Refactor of local store -* Allow to store full encrypted message bodies on dysk +- Refactor of local store (caching of size, headers and bodystructure) +- Allow to store full encrypted message bodies on a disk ### Fixed +- Improved retry mechanism for connecting to Proton servers +- OpenGL issue during startup for specific GPUs - Blurry system icons with multiple monitor setup @@ -28,15 +226,13 @@ New local cache - 2021-11-30 ### New - -- Bridge to only be checking and trying to unclock active keys, both user and address +- Bridge to only be checking and trying to unlock active keys, both user and address ## v1.8.11 - 2021-11-18 ### Fixed - - Updated bbold to v1.3.6 - including Unix fixes - Ensured 'delete' on 'All Mail' is not allowed - Fixed behaviour for 'append' of external messages to Archive @@ -49,7 +245,6 @@ New local cache - 2021-10-01 ### Fixed - - Updated crypto-libraries to gopenpgp v2.2.2 and go-srp v0.0.1 - Ensuring proper handling of updates when the user downloads the newest version manually - Better handling of an error for importing too large messages via Bridge @@ -62,7 +257,6 @@ New local cache - 2021-09-01 ### Fixed - - Fixed an issues with incorrect handling of 401 server error leading to random Bridge logouts - Changed encoding of message/rfc822 - to better handle sending of the .msg files - Fixed crash within RFC822 builder for invalid or empty headers @@ -73,11 +267,9 @@ New local cache - 2021-06-22 ### New - - Updated crypto-libraries to gopenpgp/v2 v2.1.10 ### Fixed - - Fixed IMAP/SMTP restart in Bridge to mitigate connection issues - Fixed unknown charset error for 'combined' messages - Implemented a long-term fix for 'invalid or missing message signature' error @@ -87,13 +279,11 @@ New local cache - 2021-06-11 ### New - - Updated golang Secure Remote Password Protocol - Updated crypto-libraries to gopenpgp/v2 v2.1.9 - Implemented new message parser (for imports from external accounts) ### Fixed - - Bridge not to strip PGP signatures of incoming clear text messages - Import of messages with malformed MIME header - Improved parsing of message headers @@ -105,7 +295,6 @@ New local cache - 2021-05-27 ### Fixed - - A bug with sending encrypted emails to external contacts @@ -113,7 +302,6 @@ New local cache - 2021-05-21 ### Fixed - - Hotfix for error during bug reporting @@ -121,7 +309,6 @@ New local cache - 2021-05-19 ### Fixed - - Hotfix for crash when listing empty folder @@ -129,12 +316,10 @@ New local cache - 2021-05-10 ### New - - Implemented connection manager to improve performance during weak connection, better handling of connection loss and other connectivity issues - Prompt profile installation during Apple Mail auto-configuration on MacOS Big Sur ### Fixed - - Bugs with building of message bodies/headers - Incorrect naming format of some of the attachments @@ -143,13 +328,11 @@ New local cache - 2021-04-27 ### New - - Refactor of message builder to achieve greater RFC compliance - Increased the number of message fetchers to allow more parallel requests - performance improvement - Log changes for easier debugging (update-related) ### Fixed - - Removed html-wrappig of non-decriptable messages - to facilitate decryption outside Bridge and/or allow to store such messages as they are - Tray icon issues with multiple displays on MacOS @@ -158,13 +341,11 @@ New local cache - 2021-03-30 ### New - - Revise storage locations for the config files, preferences and cache - Log improvements for easier debugging (sync issues) - Added relevant metadata to Windows builds ### Fixed - - Fixed the way Bridge interacts with Windows Firewall and Defender - Fixed potential security vulnerability related to rpath - Improved parsing of embedded messages @@ -175,39 +356,36 @@ New local cache - 2021-02-26 ### Fixed - - Fixed update notifications - Fixed GUI freeze while switching to early update channel - Fixed Bridge autostart - Improved signing of update packages + ## v1.6.5 - 2021-02-22 ### New - - Allow to choose which keychain is used by Bridge on Linux - Added automatic update CLI commands - Improved performance during slow connection - Added IMAP requests to the logs for easier debugging ### Fixed - - NoGUI bulid - Background of GUI welcome message - Incorrect total mailbox size displayed in Apple Mail + ## v1.6.3 - 2021-02-16 ### New - - Added desktop files and icon in Bridge repo - Better detection of MacOS version to improve automatic AppleMail configuration - Clearing cache after switching early access off ### Fixed - - Better poor connection handling - added retries for starting IMAP server after the connection was down - Excluding updates from 'clearing cache' - Not allowing copying from Inbox to Sent and vice versa diff --git a/release-notes/bridge_stable.md b/release-notes/bridge_stable.md index 5981af1e..b2a9215f 100644 --- a/release-notes/bridge_stable.md +++ b/release-notes/bridge_stable.md @@ -1,12 +1,140 @@ +## v2.4.8 +- 2022-11-22 + +### New +- Native Mac M1 release +- Upgrade to Qt 6: + - Change the app architecture + - Drop therecipe/qt dependency + - Update to go1.18 + - Update to Qt 6.3.2 +- Ensured the use of random port for gRPC +- Implemented token exchange for identity validation +- Ensured gRPC generates its own TLS certificate +- Increased bridge-gui timeout for gRPC server connection +- Added new warnings for 'TLS pinning' and 'no active key for recipient' errors +- GUI improvements +- More verbose logs for GUI-related issues +- New icon for .dmg installer + +### Fixed +- Improved robustness of Bridge restart +- The notification for when Bridge ports are occupied +- Fixed vulnerabilities of golang.org/x/crypto +- Missing Library on Fedora/Gnome upgrade form 2.3 to 2.4 +- Added Digital-Signature for DLLs (Windows Security Alert to show Bridge as coming from a trusted publisher) +- Change download and version check urls to proton.me +- Fixed manual check for updates after switching the update channel +- Fixes to the update process on Linux and Windows (qt6 related) + + +## v2.3.0 +- 2022-09-08 + +### New +- Feature to hide All Mail from IMAP client +- Enable automatic configuration on macOS Ventura +- Improved the scope of local logs + +### Fixed +- Visibility of Dependencies in Bridge GUI +- Potential crashes on parallel LIST command + + +## v2.2.2 +- 2022-08-03 + +### New +- Updated GUI colours to reflect new Proton's colours theme +- Renamed ProtonMail Bridge to Proton Mail Bridge - installers, keychain etc. +- New Bridge systray icons for all OSes +- New Bridge application icons for all OSes +- Visual update of macOS and Windows installers +- Add label/folder filtering to pmapi +- Use one buffered event for internet status changes - to eliminate false-positive connection errors +- Added a modal to prompt the user to reconfigure the account once a new PM address is added +- Added a link to dependencies' licences to the help section footer + +### Fixed +- Updated crypto-libraries to gopenpgp v2.4.7 and go-srp v0.0.5 +- Convert charset only for `text/*` MIME types - to ensure no attachment corruption when sending with some email clients +- Reduce unnecessary shell executions +- Syncing issues for when a new PM address is added +- Changed the wording of 'delete this account' dialog +- Improved manual update process (GUI changes) +- Improvements to manual update process + + +## v2.1.3 +- 2022-04-27 + +### New +- Added keybase/go-keychain/secretservice as a new keychain helper +- GUI changes to 'report a problem' +- Added another proxy provider +- Improved UX for working with keychain on macOS + +### Fixed +- Manual update mechanism +- Windows clipboard issues (copying account details) +- Random logouts on macOS +- Error for corrupted keychain +- Bug reporting (emails send from custom domain) + + +## v2.1.1 +- 2022-02-09 + +### New +- Improved Sentry reporting + +### Fixed +- Ensure messageID is properly removed from DB when it is no logner present on the API + + +## v2.1.0 +- 2022-01-31 + +### New +New Bridge GUI + +- Added a Status View in addition to the Main Bridge Window +- Added storage information per signed in account +- Refactor of sign in flows +- Refactor of Helps and Settings section +- Refactor of bug reports +- Refactor of Bridge update flows for beta and stable channels +- Introduced Reset Bridge feature - to clear all the local preferences and settings +- Introduce local cache configuration +- Dark Mode for Bridge, including autodetect mechanism for system colour scheme +- GUI element for changing keychain (Linux) + +New local cache + +- Refactor of local store (caching of size, headers and bodystructure) +- Allow to store full encrypted message bodies on a disk + +Other + +- Update to goopenpgp 2.4.1 +- Optimising sentry reporting + +### Fixed +- Improved retry mechanism for connecting to Proton servers +- OpenGL issue during startup for specific GPUs +- Blurry system icons with multiple monitor setup +- Bridge crashes related to unlocking local cache +- Bug with sending to 'non-encrypted' recipients +- Cosmetic GUI changes + + ## v1.8.12 - 2021-12-06 ### New - - Bridge to only be checking and trying to unclock active keys, both user and address ### Fixed - - Updated bbold to v1.3.6 - including Unix fixes - Ensure 'delete' on 'All Mail' is not allowed - Fixed behaviour for 'append' of external messages to Archive @@ -19,7 +147,6 @@ - 2021-10-13 ### Fixed - - Updated crypto-libraries to gopenpgp v2.2.2 and go-srp v0.0.1 - Ensuring proper handling of updates when the user downloads the newest version manually - Better handling of an error for importing too large messages via Bridge @@ -32,7 +159,6 @@ - 2021-09-01 ### Fixed - - Fixed an issues with incorrect handling of 401 server error leading to random Bridge logouts - Changed encoding of message/rfc822 - to better handle sending of the .msg files - Fixed crash within RFC822 builder for invalid or empty headers @@ -43,13 +169,11 @@ - 2021-06-24 ### New - - Updated golang Secure Remote Password Protocol - Updated crypto-libraries to gopenpgp/v2 v2.1.10 - Implemented new message parser (for imports from external accounts) ### Fixed - - Fixed IMAP/SMTP restart in Bridge to mitigate connection issues - Fixed unknown charset error for 'combined' messages - Implemented a long-term fix for 'invalid or missing message signature' error @@ -64,7 +188,6 @@ - 2021-05-27 ### Fixed - - A bug with sending encrypted emails to external contacts @@ -72,7 +195,6 @@ - 2021-05-21 ### Fixed - - Hotfix for error during bug reporting @@ -80,7 +202,6 @@ - 2021-05-19 ### Fixed - - Hotfix for crash when listing empty folder @@ -95,7 +216,6 @@ - Prompt profile installation during Apple Mail auto-configuration on MacOS Big Sur ### Fixed - - Bugs with building of message bodies/headers - Incorrect naming format of some of the attachments - Removed html-wrappig of non-decriptable messages - to facilitate decryption outside Bridge and/or allow to store such messages as they are @@ -106,13 +226,11 @@ - 2021-04-01 ### New - - Revise storage locations for the config files, preferences and cache - Log improvements for easier debugging (sync issues) - Added relevant metadata to Windows builds ### Fixed - - Fixed the way Bridge interacts with Windows Firewall and Defender - Fixed potential security vulnerability related to rpath - Improved parsing of embedded messages @@ -123,14 +241,12 @@ - 2021-03-04 ### New - - Allow to choose which keychain is used by Bridge on Linux - Added automatic update CLI commands - Improved performance during slow connection - Added IMAP requests to the logs for easier debugging ### Fixed - - Fixed update notifications - Fixed GUI freeze while switching to early update channel - Fixed Bridge autostart @@ -144,13 +260,11 @@ - 2021-02-16 ### New - - Added desktop files and icon in Bridge repo - Better detection of MacOS version to improve automatic AppleMail configuration - Clearing cache after switching early access off ### Fixed - - Better poor connection handling - added retries for starting IMAP server after the connection was down - Excluding updates from 'clearing cache' - Not allowing copying from Inbox to Sent and vice versa @@ -206,7 +320,6 @@ Adding a scroll bar to the settings tab - Adding GPLv3 licence button to the GUI - Improved testing - ### Fixed - AppleMail crashes (related to timestamps) - Sending messages from aliases in combined inbox mode diff --git a/release-notes/bugs-bridge.txt b/release-notes/bugs-bridge.txt deleted file mode 100644 index 49fe49a7..00000000 --- a/release-notes/bugs-bridge.txt +++ /dev/null @@ -1 +0,0 @@ -• Fixed sending error caused by inconsistent use of upper and lower case in sender’s email address diff --git a/release-notes/notes-bridge.txt b/release-notes/notes-bridge.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/utils/release_notes.sh b/utils/release_notes.sh index c0abc653..2175271d 100755 --- a/utils/release_notes.sh +++ b/utils/release_notes.sh @@ -34,5 +34,15 @@ if ! which pandoc; then exit 1 fi +# Check Pandoc version +PANDOC_VERSION=`pandoc --version | grep --color=never -m 1 "pandoc" | sed -nre 's/^[^0-9]*(([0-9]+\.)*[0-9]+).*/\1/p'` +# self-contained is deprecated since 2.19 in profit of --embed-resource option +DEPRECATING_VERSION="2.19.0" # Build release notes -pandoc "$INFILE" -f markdown -t html -s -o "$OUTFILE" -c utils/release_notes.css --self-contained --section-divs --metadata title="Release notes - Proton Mail Bridge - $CHANNEL" +if [ "$(printf '%s\n' "$requiredver" "$PANDOC_VERSION" | sort -V | head -n1)" = "$DEPRECATING_VERSION" ]; then + pandoc "$INFILE" -f markdown -t html -s -o "$OUTFILE" -c utils/release_notes.css --self-contained --section-divs --metadata title="Release notes - Proton Mail Bridge - $CHANNEL" +else + pandoc "$INFILE" -f markdown -t html -s -o "$OUTFILE" -c utils/release_notes.css --embed-resource --standalone --section-divs --metadata title="Release notes - Proton Mail Bridge - $CHANNEL" +fi + +